Skip to main content

PointToPoint2CFrameTrack

A line with points of spaced with varying distances

Properties​

hasher​

</>
PointToPoint2CFrameTrack.hasher: TrackDataHasher

length​

</>
PointToPoint2CFrameTrack.length: number

isCircuited​

</>
PointToPoint2CFrameTrack.isCircuited: boolean

circuitRemainder​

</>
PointToPoint2CFrameTrack.circuitRemainder: number

lengthWithoutCircuitRemainder​

</>
PointToPoint2CFrameTrack.lengthWithoutCircuitRemainder: boolean

Functions​

new​

Constructor
</>
PointToPoint2CFrameTrack.new(
points: {CFrame},
hashInterval: number?,--

see TrackDataHasher for default

isCircuited: boolean?--

defaults to false

) → PointToPoint2CFrameTrack

Constructor

fromInstance​

Constructor
</>
PointToPoint2CFrameTrack.fromInstance(instance: Instance) → Result<PointToPoint2CFrameTrack,string>

Creates from an Instance

Children

{
	Points: PointsInstance<CFrame>, // see PointsUtil for more info
	HashInterval: NumberValue,
	IsCircuited: BoolValue,
}

getDataFromModel​

Constructor
</>
PointToPoint2CFrameTrack.getDataFromModel(instance: Instance) → Result<PointToPoint2Data,string>

Gets data from a Model

getCFrame​

</>
PointToPoint2CFrameTrack:getCFrame(position: number) → CFrame

Gets the CFrame at the given position on the track

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructor",
            "params": [
                {
                    "name": "points",
                    "desc": "",
                    "lua_type": "{CFrame}"
                },
                {
                    "name": "hashInterval",
                    "desc": "see TrackDataHasher for default",
                    "lua_type": "number?"
                },
                {
                    "name": "isCircuited",
                    "desc": "defaults to false",
                    "lua_type": "boolean?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "PointToPoint2CFrameTrack"
                }
            ],
            "function_type": "static",
            "tags": [
                "Constructor"
            ],
            "source": {
                "line": 49,
                "path": "src/shared/cframeTrack/PointToPoint2.lua"
            }
        },
        {
            "name": "fromInstance",
            "desc": "Creates from an Instance\n### Children\n```ts\n{\n\tPoints: PointsInstance<CFrame>, // see PointsUtil for more info\n\tHashInterval: NumberValue,\n\tIsCircuited: BoolValue,\n}\n```",
            "params": [
                {
                    "name": "instance",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Result<PointToPoint2CFrameTrack, string>"
                }
            ],
            "function_type": "static",
            "tags": [
                "Constructor"
            ],
            "source": {
                "line": 96,
                "path": "src/shared/cframeTrack/PointToPoint2.lua"
            }
        },
        {
            "name": "getDataFromModel",
            "desc": "Gets data from a Model",
            "params": [
                {
                    "name": "instance",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Result<PointToPoint2Data, string>"
                }
            ],
            "function_type": "static",
            "tags": [
                "Constructor"
            ],
            "source": {
                "line": 133,
                "path": "src/shared/cframeTrack/PointToPoint2.lua"
            }
        },
        {
            "name": "Destroy",
            "desc": "",
            "params": [],
            "returns": [],
            "function_type": "method",
            "private": true,
            "source": {
                "line": 206,
                "path": "src/shared/cframeTrack/PointToPoint2.lua"
            }
        },
        {
            "name": "getCFrame",
            "desc": "Gets the CFrame at the given position on the track",
            "params": [
                {
                    "name": "position",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "CFrame"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 216,
                "path": "src/shared/cframeTrack/PointToPoint2.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "hasher",
            "desc": "",
            "lua_type": "TrackDataHasher",
            "source": {
                "line": 26,
                "path": "src/shared/cframeTrack/PointToPoint2.lua"
            }
        },
        {
            "name": "length",
            "desc": "",
            "lua_type": "number",
            "source": {
                "line": 29,
                "path": "src/shared/cframeTrack/PointToPoint2.lua"
            }
        },
        {
            "name": "isCircuited",
            "desc": "",
            "lua_type": "boolean",
            "source": {
                "line": 32,
                "path": "src/shared/cframeTrack/PointToPoint2.lua"
            }
        },
        {
            "name": "circuitRemainder",
            "desc": "",
            "lua_type": "number",
            "source": {
                "line": 35,
                "path": "src/shared/cframeTrack/PointToPoint2.lua"
            }
        },
        {
            "name": "lengthWithoutCircuitRemainder",
            "desc": "",
            "lua_type": "boolean",
            "source": {
                "line": 38,
                "path": "src/shared/cframeTrack/PointToPoint2.lua"
            }
        }
    ],
    "types": [],
    "name": "PointToPoint2CFrameTrack",
    "desc": "A line with points of spaced with varying distances",
    "source": {
        "line": 23,
        "path": "src/shared/cframeTrack/PointToPoint2.lua"
    }
}