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

characters

const characters: PluginFactory<[CharactersOptions], Plugin<FlatSystemHandles<object & object & object & object>, CharacterInputDeclarations, Readonly<Record<never, never>>, "players" | "npcs", { stop: CommandDeclaration<{ }, WalkRefusal, undefined, true, false, true>; walk: CommandDeclaration<{ to: Vector3CommandField; }, WalkRefusal, undefined, true, false, true>; }, { walking: InputContextDeclaration; }>>

The characters: each one’s movement on its input or along its path, its pushes and speed modifiers, and the character each player gets as she joins a room. A game whose players walk lists it; a game whose players control something else, or nothing, lists none.

It declares the five inputs a character steps on, which a system reads with readInput(character, characters.inputs.move): move, a vector on W, A, S and D and the arrows; heading and pitch, angles the page’s camera sets; strafe, a button the camera’s lock holds; and jump, an edge button on Space.