Skip to content

@fibbojs / 2d / FCharacterControllerD

Class: FCharacterControllerD ​

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

Example ​

ts
import { FCharacterControllerD, FRectangle } from '@fibbojs/2d'

const rectangle = new FRectangle()
rectangle.addController(new FCharacterControllerD())

Extends ​

Constructors ​

new FCharacterControllerD() ​

new FCharacterControllerD(options): FCharacterControllerD

Parameters ​

• options: FCharacterControllerOptions

Returns ​

FCharacterControllerD

Overrides ​

FCharacterController.constructor

Defined in ​

2d/src/controllers/FCharacterControllerD.ts:18

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 ​

2d/src/controllers/FCharacterControllerD.ts:36

Properties ​

__RUN_IN_PHYSIC_PIPELINE__ ​

__RUN_IN_PHYSIC_PIPELINE__: boolean

True if the controller should run in the physic pipeline.

Inherited from ​

FCharacterController.__RUN_IN_PHYSIC_PIPELINE__

Defined in ​

core/dist/index.d.ts:20


component ​

component: FComponent

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

Inherited from ​

FCharacterController.component

Defined in ​

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


inputs ​

inputs: object

The inputs that will be used to move the character.

down ​

down: boolean

left ​

left: boolean

right: boolean

up ​

up: boolean

Inherited from ​

FCharacterController.inputs

Defined in ​

2d/src/controllers/FCharacterController.ts:21


scene ​

scene: FScene

The scene where the character is.

Inherited from ​

FCharacterController.scene

Defined in ​

2d/src/controllers/FCharacterController.ts:36


speed ​

speed: number

The speed of the character.

Inherited from ​

FCharacterController.speed

Defined in ​

2d/src/controllers/FCharacterController.ts:31