Skip to content

@fibbojs / 3d / FCharacterControllerD

Class: FCharacterControllerD

A pre-defined character controller based on a Dynamic RigidBody.

Example

ts
import { FCapsule, FCharacterControllerD, FScene } from '@fibbojs/3d'

const scene = new FScene()

const capsule = new FCapsule(scene)
capsule.controller = new FCharacterControllerD(scene)
scene.addComponent(capsule)

Extends

Constructors

new FCharacterControllerD()

new FCharacterControllerD(scene, options): FCharacterControllerD

Parameters

scene: FScene

options: FCharacterControllerOptions

Returns

FCharacterControllerD

Overrides

FCharacterController.constructor

Defined in

3d/src/controllers/FCharacterControllerD.ts:23

Methods

frame()

frame(_delta): void

Update the controller. Should be called every frame. The purpose of this method is to update the component transform based on the controller logic.

Parameters

_delta: number

Returns

void

Overrides

FCharacterController.frame

Defined in

3d/src/controllers/FCharacterControllerD.ts:39


getCorrectedRotation()

getCorrectedRotation(): Quaternion

Return the corrected rotation for the current frame. Uses the camera so the character nevers faces the camera.

Returns

Quaternion

Inherited from

FCharacterController.getCorrectedRotation

Defined in

3d/src/controllers/FCharacterController.ts:121

Properties

component

component: FComponent

The component attached to the controller. It is redefined here to get the correct type (with 3D properties).

Inherited from

FCharacterController.component

Defined in

3d/src/controllers/FController.ts:17


inputs

inputs: object

The inputs that will be used to move the character.

backward

backward: boolean

forward

forward: boolean

left

left: boolean

right: boolean

Inherited from

FCharacterController.inputs

Defined in

3d/src/controllers/FCharacterController.ts:24


scene

scene: FScene

The scene where the character is.

Inherited from

FCharacterController.scene

Defined in

3d/src/controllers/FCharacterController.ts:39


speed

speed: number

The speed of the character.

Inherited from

FCharacterController.speed

Defined in

3d/src/controllers/FCharacterController.ts:34