Skip to content

@fibbojs / 2d / FCharacterController

Class: abstract FCharacterController ​

An abstract pre-defined character controller.

Extends ​

Extended by ​

Constructors ​

new FCharacterController() ​

new FCharacterController(options): FCharacterController

Parameters ​

• options: FCharacterControllerOptions

Returns ​

FCharacterController

Overrides ​

FController.constructor

Defined in ​

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

Methods ​

frame() ​

abstract 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

The time since the last frame.

Returns ​

void

Inherited from ​

FController.frame

Defined in ​

core/dist/index.d.ts:32

Properties ​

__RUN_IN_PHYSIC_PIPELINE__ ​

__RUN_IN_PHYSIC_PIPELINE__: boolean

True if the controller should run in the physic pipeline.

Inherited from ​

FController.__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 ​

FController.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

Defined in ​

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


scene ​

scene: FScene

The scene where the character is.

Defined in ​

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


speed ​

speed: number

The speed of the character.

Defined in ​

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