@fibbojs / 3d / FCharacterControllerKV
Class: FCharacterControllerKV
A pre-defined character controller based on a Kinematic Velocity RigidBody.
Example
import { FCapsule, FCharacterControllerKV, FScene } from '@fibbojs/3d'
const scene = new FScene()
const capsule = new FCapsule(scene)
capsule.controller = new FCharacterControllerKV(scene)
scene.addComponent(capsule)
Extends
Constructors
new FCharacterControllerKV()
new FCharacterControllerKV(
scene
,options
):FCharacterControllerKV
Parameters
• scene: FScene
• options: FCharacterControllerOptions
Returns
Overrides
FCharacterControllerK
.constructor
Defined in
3d/src/controllers/FCharacterControllerKV.ts:21
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
The time since the last frame.
Returns
void
Overrides
Defined in
3d/src/controllers/FCharacterControllerKV.ts:31
getCorrectedMovements()
getCorrectedMovements():
FVector3
Return the corrected movements for the current frame.
Returns
Inherited from
FCharacterControllerK
.getCorrectedMovements
Defined in
3d/src/controllers/FCharacterControllerK.ts:48
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
FCharacterControllerK
.getCorrectedRotation
Defined in
3d/src/controllers/FCharacterController.ts:121
Properties
characterController
characterController:
KinematicCharacterController
The character controller that will be used to move the character.
Inherited from
FCharacterControllerK
.characterController
Defined in
3d/src/controllers/FCharacterControllerK.ts:22
component
component:
FComponent
The component attached to the controller. It is redefined here to get the correct type (with 3D properties).
Inherited from
FCharacterControllerK
.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
right:
boolean
Inherited from
Defined in
3d/src/controllers/FCharacterController.ts:24
scene
scene:
FScene
The scene where the character is.
Inherited from
Defined in
3d/src/controllers/FCharacterController.ts:39
speed
speed:
number
The speed of the character.
Inherited from
Defined in
3d/src/controllers/FCharacterController.ts:34
yVelocity
yVelocity:
number
The y velocity of the character. Used to apply gravity.
Inherited from
FCharacterControllerK
.yVelocity