Skip to main content

PointToPointCFrameTrack

A line with equidistant points

Properties​

points​

</>
PointToPointCFrameTrack.points: {CFrame}

distanceBetweenPoints​

</>
PointToPointCFrameTrack.distanceBetweenPoints: number

length​

</>
PointToPointCFrameTrack.length: number

isCircuited​

</>
PointToPointCFrameTrack.isCircuited: boolean

circuitRemainder​

</>
PointToPointCFrameTrack.circuitRemainder: number

lengthWithoutCircuitRemainder​

</>
PointToPointCFrameTrack.lengthWithoutCircuitRemainder: number

Functions​

new​

Constructor
</>
PointToPointCFrameTrack.new() → PointToPointCFrameTrack

Constructor

fromInstance​

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

Constructs a new PointToPointCFrameTrack from an Instance

Children

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

getDataFromModel​

</>
PointToPointCFrameTrack.getDataFromModel(instance: Instance) → Result<PointToPointData,string>

Gets data from a Model

getDataFromModuleScript​

</>
PointToPointCFrameTrack.getDataFromModuleScript(moduleScript: ModuleScript) → Result<PointToPointData,string>

Gets PointToPointData from a ModuleScript

Destroy​

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

getCFrame​

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

Returns a CFrame

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructor",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "PointToPointCFrameTrack"
                }
            ],
            "function_type": "static",
            "tags": [
                "Constructor"
            ],
            "source": {
                "line": 46,
                "path": "src/shared/cframeTrack/PointToPoint.lua"
            }
        },
        {
            "name": "fromInstance",
            "desc": "Constructs a new PointToPointCFrameTrack from an Instance\n### Children\n```ts\n{\n\tPoints: PointsInstance<CFrame>, // see PointsUtil for more info\n\tDistanceBetweenPoints: NumberValue,\n\tIsCircuited: BoolValue,\n}\n```",
            "params": [
                {
                    "name": "instance",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Result<PointToPointCFrameTrack, string>"
                }
            ],
            "function_type": "static",
            "tags": [
                "Constructor"
            ],
            "source": {
                "line": 73,
                "path": "src/shared/cframeTrack/PointToPoint.lua"
            }
        },
        {
            "name": "getDataFromModel",
            "desc": "Gets data from a Model",
            "params": [
                {
                    "name": "instance",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Result<PointToPointData, string>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 107,
                "path": "src/shared/cframeTrack/PointToPoint.lua"
            }
        },
        {
            "name": "getDataFromModuleScript",
            "desc": "Gets PointToPointData from a ModuleScript",
            "params": [
                {
                    "name": "moduleScript",
                    "desc": "",
                    "lua_type": "ModuleScript"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Result<PointToPointData, string>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 140,
                "path": "src/shared/cframeTrack/PointToPoint.lua"
            }
        },
        {
            "name": "Destroy",
            "desc": "",
            "params": [],
            "returns": [],
            "function_type": "method",
            "tags": [
                "Deconstructor"
            ],
            "source": {
                "line": 176,
                "path": "src/shared/cframeTrack/PointToPoint.lua"
            }
        },
        {
            "name": "_setData",
            "desc": "",
            "params": [
                {
                    "name": "data",
                    "desc": "",
                    "lua_type": "PointToPointData"
                }
            ],
            "returns": [],
            "function_type": "method",
            "private": true,
            "source": {
                "line": 185,
                "path": "src/shared/cframeTrack/PointToPoint.lua"
            }
        },
        {
            "name": "getCFrame",
            "desc": "Returns a CFrame",
            "params": [
                {
                    "name": "position",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "CFrame"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 223,
                "path": "src/shared/cframeTrack/PointToPoint.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "points",
            "desc": "",
            "lua_type": "{CFrame}",
            "source": {
                "line": 23,
                "path": "src/shared/cframeTrack/PointToPoint.lua"
            }
        },
        {
            "name": "distanceBetweenPoints",
            "desc": "",
            "lua_type": "number",
            "source": {
                "line": 26,
                "path": "src/shared/cframeTrack/PointToPoint.lua"
            }
        },
        {
            "name": "length",
            "desc": "",
            "lua_type": "number",
            "source": {
                "line": 29,
                "path": "src/shared/cframeTrack/PointToPoint.lua"
            }
        },
        {
            "name": "isCircuited",
            "desc": "",
            "lua_type": "boolean",
            "source": {
                "line": 32,
                "path": "src/shared/cframeTrack/PointToPoint.lua"
            }
        },
        {
            "name": "circuitRemainder",
            "desc": "",
            "lua_type": "number",
            "source": {
                "line": 35,
                "path": "src/shared/cframeTrack/PointToPoint.lua"
            }
        },
        {
            "name": "lengthWithoutCircuitRemainder",
            "desc": "",
            "lua_type": "number",
            "source": {
                "line": 38,
                "path": "src/shared/cframeTrack/PointToPoint.lua"
            }
        }
    ],
    "types": [],
    "name": "PointToPointCFrameTrack",
    "desc": "A line with equidistant points",
    "source": {
        "line": 20,
        "path": "src/shared/cframeTrack/PointToPoint.lua"
    }
}