Class CharacterController

constructor

• new CharacterController(
      world: PhysicsWorld,
      opts?: CharacterOptions,
  ): CharacterController

  Parameters

  • world: PhysicsWorld
  • opts: CharacterOptions = {}

  Returns CharacterController

Readonlyvelocity

gravity

position

• get position(): Vec3

  Current capsule-center world position.

  Returns Vec3

groundState

• get groundState(): GroundState

  Current ground classification.

  Returns GroundState

isGrounded

• get isGrounded(): boolean

  True when standing on walkable ground.

  Returns boolean

groundNormal

• get groundNormal(): Vec3

  Normal of the ground under the feet (up if airborne).

  Returns Vec3

setPosition

• setPosition(p: Vec3): void

  Teleports the character.

  Parameters

  • p: Vec3

  Returns void

setRotation

• setRotation(q: Quaternion): void

  Sets the capsule's facing (usually left identity; rotate the model instead).

  Parameters

  • q: Quaternion

  Returns void

jump

• jump(speed: number): void

  Sets a vertical launch velocity if currently grounded (a jump).

  Parameters

  • speed: number

  Returns void

move

• move(dt: number): void

  Advances the character by dt: integrates gravity into velocity.y, sweeps the capsule through the world (sliding, stairs, floor-stick) and writes the collision-resolved position and velocity back. Set the desired horizontal velocity (and any jump on velocity.y) before calling.

  Parameters

  • dt: number

  Returns void

destroy

• destroy(): void

  Frees the Jolt objects backing this controller.

  Returns void