Class FPSController

A controller for first-person style movement and looking.

Hierarchy (View Summary)

Behavior
- FPSController

Index

Constructors

Properties

enabled isActive target uuid inspector?

Methods

clone onAttach onDetach update

Constructors

constructor

new FPSController(options?: FPSControllerOptions): FPSController
Creates a new FPSController.
Parameters
- options: FPSControllerOptions = {}
  The configuration options.
Returns FPSController
Overrides Behavior.constructor
- Defined in core/controllers/FPSController.ts:53

Properties

enabled

enabled: boolean = true

isActive

isActive: boolean = true

target

target: CameraInterfaceData | Object3D | undefined = undefined

The object this behavior is attached to. Set automatically.

`Readonly`uuid

uuid: string = ...

`Static` `Optional` `Readonly`inspector

inspector?: Record<string, InspectorField>

Methods

clone

clone(): Behavior
Returns an independent copy of this behavior (own uuid, target cleared -- the caller is expected to attachBehavior() it onto the new host, which sets target correctly via onAttach()). Used by Object3D.clone() (Maker's Duplicate command).

Returns Behavior
Inherited from Behavior.clone
- Defined in core/behaviors/Behavior.ts:43

onAttach

onAttach(target: CameraInterfaceData | Object3D): void
Called when the behavior is attached to an object.
Parameters
- target: CameraInterfaceData | Object3D
Returns void
Overrides Behavior.onAttach
- Defined in core/controllers/FPSController.ts:73

onDetach

onDetach(): void
Called when the behavior is detached from an object.

Returns void
Inherited from Behavior.onDetach
- Defined in core/behaviors/Behavior.ts:34

update

update(deltaTime: number): void
Called every frame to update the behavior logic.
Parameters
- deltaTime: number
  The time elapsed since the last frame in seconds.
Returns void
Overrides Behavior.update
- Defined in core/controllers/FPSController.ts:81