Skip to content
Work in progress. These docs describe Spawnite at launch, and some parts are still being built.

ModelRegistration

What registerModel takes beside a bare url: a manifest’s entry, or a path alone, either with the material the model wears.

  • Pick<ModelEntry, "path">.Partial<Omit<ModelEntry, "path">>
Property Type Description
bounds? ModelBounds -
capsule? ModelCapsule -
hull? ModelHull Kept only for the models a manifest’s folder names, as the kit names its scatter models.
hullPoints? number[] The corners of its convex hull in its own space, three numbers to a corner: the points a hull collider wraps, on the page and in a room. A game’s manifest keeps them; the kit’s, which no page registers, does not.
material? ModelMaterial What the model wears in place of each of its materials wherever the engine draws it by this name: an <Entity>, an <InstancedModel>, a map’s prop, and an entity a system spawns or a room streams, on every page. A component’s own material goes over it. A function cannot travel to another page, and a name can: in a room, the registration is how each page dresses the entities the room spawns. Every page registers its models from the same module, so each holds the same function.
path string The file’s path from the folder above the models folder. In a game’s manifest that folder is public, so the path is where the page fetches the file, relative to the page, and a game served under a folder of its own finds it. The kit’s paths are relative to its package, which no page serves.