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

MoveCharacterOptions

What moveCharacter takes.

Property Type Description
impulse? Vector3Like Metres a second added at once: its upward part to her rising speed and its sideways part to her externalVelocity, for a bounce pad, a wall jump or a ground pound.
jump? boolean Launches her now, to the controller’s jumpHeight, on the floor or not: when a jump is allowed is the movement’s to decide.
overrides? Partial<Omit<{ floorSnapDistance: number; gravity: boolean; gravityScale: number; groundFriction: number; height: number; jumpHeight: number; maxSlopeRadians: number; platformOnLeave: PlatformOnLeave; pushes: CollisionMask | null; stepHeight: number; turnWithPlatform: boolean; }, "pushes">> Controller settings for this call alone.
rotation? QuaternionLike Her rotation after the move; left out, unchanged.
velocity Vector3Like Metres a second along the ground. Its y is read only while the controller’s gravity is off, for a glide, a ladder or a swim: with gravity on, the controller owns her vertical speed.