Class FirstPersonController

A generalized First Person Controller handling movement, rotation, and collisions.

Hierarchy (View Summary)

Behavior
- FirstPersonController

Index

Constructors

Properties

_collider? _options bobPhase distanceMoved enabled isActive isMoving target uuid inspector?

Methods

onAttach onDetach update

Constructors

constructor

new FirstPersonController(
options?: FirstPersonControllerOptions,
): FirstPersonController
Creates a new FirstPersonController.
Parameters
- options: FirstPersonControllerOptions = {}
  The configuration options.
Returns FirstPersonController
Overrides Behavior.constructor
- Defined in core/behaviors/FirstPersonController.ts:53

Properties

`Protected` `Optional`_collider

_collider?: BoundingSphere

`Protected`_options

_options: Required<Omit<FirstPersonControllerOptions, "input" | "scene">> & {
input: InputInterface;
scene: Scene | undefined;
}

bobPhase

bobPhase: number = 0

distanceMoved

distanceMoved: number = 0

enabled

enabled: boolean = true

isActive

isActive: boolean = true

isMoving

isMoving: boolean = false

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

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/behaviors/FirstPersonController.ts:71

onDetach

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

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

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/behaviors/FirstPersonController.ts:76