Kinemium Docs

CharacterController

High-level modular character controller.

Functions


newObject

Arguments

className

Returns

This function returns nothing.

ensureArchitecture

Arguments

This function takes no arguments.

Returns

This function returns nothing.

instance:Move

Arguments

direction

Returns

This function returns nothing.

instance:MoveRelative

Arguments

direction, basis

Returns

This function returns nothing.

instance:Jump

Arguments

This function takes no arguments.

Returns

This function returns nothing.

instance:RequestJump

Arguments

This function takes no arguments.

Returns

This function returns nothing.

instance:SetSprinting

Arguments

sprinting

Returns

This function returns nothing.

instance:Face

Arguments

direction

Returns

This function returns nothing.

instance:ClearFacingDirection

Arguments

This function takes no arguments.

Returns

This function returns nothing.

instance:GetState

Arguments

This function takes no arguments.

Returns

This function returns nothing.

instance:ChangeState

Arguments

nextState

Returns

This function returns nothing.

instance:GetMotor

Arguments

This function takes no arguments.

Returns

This function returns nothing.

instance:GetComponent

Arguments

name

Returns

This function returns nothing.

instance:Step

Arguments

dt

Returns

This function returns nothing.

bindComponentProperty

Arguments

property, componentName, componentProperty

Returns

This function returns nothing.

API

instance:newObject(className)
instance:ensureArchitecture()
instance:Move(direction)
instance:MoveRelative(direction, basis)
instance:Jump()
instance:RequestJump()
instance:SetSprinting(sprinting)
instance:Face(direction)
instance:ClearFacingDirection()
instance:GetState()
instance:ChangeState(nextState)
instance:GetMotor()
instance:GetComponent(name)
instance:Step(dt)
instance:bindComponentProperty(property, componentName, componentProperty)

On this page