Skip to main content

CharacterController

CharacterControllers are responsible for the state handling and physics of the Luanoid such as movement. Luanoids can accept different CharacterControllers by setting the CharacterController propery on them.

See Custom CharacterControllers for writing your own CharacterController.

Properties

Luanoid

This item is read only and cannot be modified. Read Only
</>
CharacterController.Luanoid: Luanoid

Reference to the Luanoid this CharacterController is attached to.

RaycastParams

</>
CharacterController.RaycastParams: RaycastParams

RaycastParams used to cast to the ground underneath the Luanoid's character.

CanRedirectJump

</>
CharacterController.CanRedirectJump: boolean

Whether or not the Luanoid can "walk" when jumping. Default is true to behave more like Humanoids.

Running

This item is read only and cannot be modified. Read Only
</>
CharacterController.Running: boolean

Whether the CharacterController is currently running.

FiniteStateMachine

</>
CharacterController.FiniteStateMachine: (characterController: CharacterController) → CharacterState

Callback that returns a CharacterState the Luanoid should currently be in.

States

This item is read only and cannot be modified. Read Only
</>
CharacterController.States: {[CharacterState]: {
Entered: Signal,
Leaving: Signal,
Step: Signal
}}

Table of signals fired when a state is entered, leaving, or stepped.

LastState

This item is read only and cannot be modified. Read Only
</>
CharacterController.LastState: CharacterState

The previous CharacterState applied to the Launoid.

StateEnterTick

This item is read only and cannot be modified. Read Only
</>
CharacterController.StateEnterTick: number

The time the Luanoid entered its current CharacterState using tick().

StateEnterPosition

This item is read only and cannot be modified. Read Only
</>
CharacterController.StateEnterPosition: Vector3

The position the Luanoid entered its current CharacterState.

RaycastResult

This item is read only and cannot be modified. Read Only
</>
CharacterController.RaycastResult: RaycastResult

The CharacterController casts a ray to the ground from the corners and center of the RootPart. This is the result of the ray hitting closest to the RootPart.

RaycastResults

This item is read only and cannot be modified. Read Only
</>
CharacterController.RaycastResults: {RaycastResult}

All rays casted by the CharacterController on this step of the simulation.

Stores

</>
CharacterController.Stores: {[string]: any}

Container for data to be stored and shared between the state handlers and FiniteStateMachine.

Functions

new

</>
CharacterController.new(
luanoid: Luanoid,
states: CharacterState,
fsm: (characterController: CharacterController) → CharacterState
) → CharacterController

Creates a new CharacterController.

CastCollideOnly

</>
CharacterController:CastCollideOnly(
origin: Vector3,
dir: Vector3
) → RaycastResult

Casts a ray while ignoring all Instances with CanCollide set to false. Intended for use primarily within the CharacterController.

GetStateElapsedTime

</>
CharacterController:GetStateElapsedTime() → number

Returns the elapsed time since the Luanoid entering its current state.

Start

</>
CharacterController:Start() → ()

Starts the CharacterController's simulation.

Stop

</>
CharacterController:Stop() → ()

Stops the CharacterController's simulation.

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Creates a new CharacterController.",
            "params": [
                {
                    "name": "luanoid",
                    "desc": "",
                    "lua_type": "Luanoid"
                },
                {
                    "name": "states",
                    "desc": "",
                    "lua_type": "CharacterState"
                },
                {
                    "name": "fsm",
                    "desc": "",
                    "lua_type": "(characterController: CharacterController) -> CharacterState"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "CharacterController"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 150,
                "path": "src/CharacterController.lua"
            }
        },
        {
            "name": "CastCollideOnly",
            "desc": "Casts a ray while ignoring all Instances with `CanCollide` set to `false`.\nIntended for use primarily within the CharacterController.",
            "params": [
                {
                    "name": "origin",
                    "desc": "",
                    "lua_type": "Vector3"
                },
                {
                    "name": "dir",
                    "desc": "",
                    "lua_type": "Vector3"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "RaycastResult"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 198,
                "path": "src/CharacterController.lua"
            }
        },
        {
            "name": "GetStateElapsedTime",
            "desc": "Returns the elapsed time since the Luanoid entering its current state.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 227,
                "path": "src/CharacterController.lua"
            }
        },
        {
            "name": "Start",
            "desc": "Starts the CharacterController's simulation.",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 236,
                "path": "src/CharacterController.lua"
            }
        },
        {
            "name": "Stop",
            "desc": "Stops the CharacterController's simulation.",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 259,
                "path": "src/CharacterController.lua"
            }
        },
        {
            "name": "_step",
            "desc": "Performs a single step of the CharacterController's simulation.",
            "params": [
                {
                    "name": "dt",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "method",
            "private": true,
            "source": {
                "line": 276,
                "path": "src/CharacterController.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "Luanoid",
            "desc": "Reference to the Luanoid this CharacterController is attached to.\n        ",
            "lua_type": "Luanoid",
            "readonly": true,
            "source": {
                "line": 31,
                "path": "src/CharacterController.lua"
            }
        },
        {
            "name": "RaycastParams",
            "desc": "RaycastParams used to cast to the ground underneath the Luanoid's character.\n        ",
            "lua_type": "RaycastParams",
            "source": {
                "line": 38,
                "path": "src/CharacterController.lua"
            }
        },
        {
            "name": "CanRedirectJump",
            "desc": "Whether or not the Luanoid can \"walk\" when jumping. Default is\n`true` to behave more like Humanoids.\n        ",
            "lua_type": "boolean",
            "source": {
                "line": 46,
                "path": "src/CharacterController.lua"
            }
        },
        {
            "name": "Running",
            "desc": "Whether the CharacterController is currently running.\n        ",
            "lua_type": "boolean",
            "readonly": true,
            "source": {
                "line": 54,
                "path": "src/CharacterController.lua"
            }
        },
        {
            "name": "FiniteStateMachine",
            "desc": "Callback that returns a `CharacterState` the Luanoid should currently be in.\n        ",
            "lua_type": "(characterController: CharacterController) -> CharacterState",
            "source": {
                "line": 61,
                "path": "src/CharacterController.lua"
            }
        },
        {
            "name": "States",
            "desc": "Table of signals fired when a state is entered, leaving, or stepped.\n        ",
            "lua_type": "{[CharacterState]: { Entered: Signal, Leaving: Signal, Step: Signal }}",
            "readonly": true,
            "source": {
                "line": 69,
                "path": "src/CharacterController.lua"
            }
        },
        {
            "name": "LastState",
            "desc": "The previous CharacterState applied to the Launoid.\n        ",
            "lua_type": "CharacterState",
            "readonly": true,
            "source": {
                "line": 77,
                "path": "src/CharacterController.lua"
            }
        },
        {
            "name": "StateEnterTick",
            "desc": "The time the Luanoid entered its current CharacterState using `tick()`.\n        ",
            "lua_type": "number",
            "readonly": true,
            "source": {
                "line": 85,
                "path": "src/CharacterController.lua"
            }
        },
        {
            "name": "StateEnterPosition",
            "desc": "The position the Luanoid entered its current CharacterState.\n        ",
            "lua_type": "Vector3",
            "readonly": true,
            "source": {
                "line": 93,
                "path": "src/CharacterController.lua"
            }
        },
        {
            "name": "RaycastResult",
            "desc": "The CharacterController casts a ray to the ground from the corners\nand center of the RootPart. This is the result of the ray hitting\nclosest to the RootPart.\n        ",
            "lua_type": "RaycastResult",
            "readonly": true,
            "source": {
                "line": 103,
                "path": "src/CharacterController.lua"
            }
        },
        {
            "name": "RaycastResults",
            "desc": "All rays casted by the CharacterController on this step of the\nsimulation.\n        ",
            "lua_type": "{RaycastResult}",
            "readonly": true,
            "source": {
                "line": 112,
                "path": "src/CharacterController.lua"
            }
        },
        {
            "name": "Stores",
            "desc": "Container for data to be stored and shared between the state\nhandlers and FiniteStateMachine.\n        ",
            "lua_type": "{[string]: any}",
            "source": {
                "line": 120,
                "path": "src/CharacterController.lua"
            }
        }
    ],
    "types": [],
    "name": "CharacterController",
    "desc": "CharacterControllers are responsible for the state handling and physics of\nthe Luanoid such as movement. Luanoids can accept different\nCharacterControllers by setting the `CharacterController` propery on them.\n\nSee [Custom CharacterControllers](/docs/customCharacterControllers) for\nwriting your own CharacterController.",
    "source": {
        "line": 20,
        "path": "src/CharacterController.lua"
    }
}