Skip to main content

CFrameTrack

Defines a track

Properties​

name​

This item is read only and cannot be modified. Read Only
</>
CFrameTrack.name: string

length​

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

isCircuited​

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

Functions​

new​

Constructor
</>
CFrameTrack.new() → CFrameTrack

Constructor for CFrameTrack

fromInstance​

Constructor
</>
CFrameTrack.fromInstance(_instance: Instance) → ()

Constructor. Constructs a CFrameTrack from an Instance

Errors

TypeDescription
"Not Implemented"

Destroy​

Deconstructor
</>
CFrameTrack:Destroy() → ()

Deconstructor

clampToLength​

</>
CFrameTrack:clampToLength(position: number) → any

Clamps the given position to this track's length

hasPassedEnd​

</>
CFrameTrack:hasPassedEnd(position: number) → (
Option<boolean>,
number
)

Returns the direction which the given position passes the end of the track line. Also returns the clamped position. See clampToTrackLength for more info.

getCFrame​

</>
CFrameTrack:getCFrame(_position: number) → CFrame

Returns a CFrame from the given track position

getPositionOffsetCFrames​

</>
CFrameTrack:getPositionOffsetCFrames(
position: number,--

Position along the track

positionOffsets: {number}--

PositionOffsets

) → {CFrame}

Returns for a set of positions as if they were one group Used primarily for trains

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructor for CFrameTrack",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "CFrameTrack"
                }
            ],
            "function_type": "static",
            "tags": [
                "Constructor"
            ],
            "source": {
                "line": 33,
                "path": "src/shared/cframeTrack/CFrameTrack.lua"
            }
        },
        {
            "name": "fromInstance",
            "desc": "Constructor.\nConstructs a CFrameTrack from an Instance",
            "params": [
                {
                    "name": "_instance",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [],
            "function_type": "static",
            "tags": [
                "Constructor"
            ],
            "errors": [
                {
                    "lua_type": "\"Not Implemented\"",
                    "desc": ""
                }
            ],
            "source": {
                "line": 47,
                "path": "src/shared/cframeTrack/CFrameTrack.lua"
            }
        },
        {
            "name": "Destroy",
            "desc": "Deconstructor",
            "params": [],
            "returns": [],
            "function_type": "method",
            "tags": [
                "Deconstructor"
            ],
            "source": {
                "line": 53,
                "path": "src/shared/cframeTrack/CFrameTrack.lua"
            }
        },
        {
            "name": "clampToLength",
            "desc": "Clamps the given position to this track's length",
            "params": [
                {
                    "name": "position",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 60,
                "path": "src/shared/cframeTrack/CFrameTrack.lua"
            }
        },
        {
            "name": "hasPassedEnd",
            "desc": "Returns the direction which the given position passes the end of the track line.\nAlso returns the clamped position. See clampToTrackLength for more info.",
            "params": [
                {
                    "name": "position",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Option<boolean>"
                },
                {
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 69,
                "path": "src/shared/cframeTrack/CFrameTrack.lua"
            }
        },
        {
            "name": "getCFrame",
            "desc": "Returns a CFrame from the given track position",
            "params": [
                {
                    "name": "_position",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "CFrame"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 76,
                "path": "src/shared/cframeTrack/CFrameTrack.lua"
            }
        },
        {
            "name": "getPositionOffsetCFrames",
            "desc": "Returns for a set of positions as if they were one group\nUsed primarily for trains",
            "params": [
                {
                    "name": "position",
                    "desc": "Position along the track",
                    "lua_type": "number"
                },
                {
                    "name": "positionOffsets",
                    "desc": "PositionOffsets",
                    "lua_type": "{number}"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{CFrame}"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 85,
                "path": "src/shared/cframeTrack/CFrameTrack.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "name",
            "desc": "",
            "lua_type": "string",
            "readonly": true,
            "source": {
                "line": 18,
                "path": "src/shared/cframeTrack/CFrameTrack.lua"
            }
        },
        {
            "name": "length",
            "desc": "",
            "lua_type": "number",
            "readonly": true,
            "source": {
                "line": 22,
                "path": "src/shared/cframeTrack/CFrameTrack.lua"
            }
        },
        {
            "name": "isCircuited",
            "desc": "",
            "lua_type": "boolean",
            "readonly": true,
            "source": {
                "line": 26,
                "path": "src/shared/cframeTrack/CFrameTrack.lua"
            }
        }
    ],
    "types": [],
    "name": "CFrameTrack",
    "desc": "Defines a track",
    "source": {
        "line": 14,
        "path": "src/shared/cframeTrack/CFrameTrack.lua"
    }
}