Skip to main content

PointCFrameTrack

Single CFrame position track.

Properties​

length​

</>
PointCFrameTrack.length: number

Set to 0

isCircuited​

</>
PointCFrameTrack.isCircuited: boolean

Set to false

Functions​

new​

Constructor
</>
PointCFrameTrack.new(position: CFrame) → PointCFrameTrack

Constructor

fromInstance​

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

Creates from an Instance

Children

{
	Position: CFrameInstance,
}

getCFrame​

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

Returns a CFrame

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructor",
            "params": [
                {
                    "name": "position",
                    "desc": "",
                    "lua_type": "CFrame"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "PointCFrameTrack"
                }
            ],
            "function_type": "static",
            "tags": [
                "Constructor"
            ],
            "source": {
                "line": 30,
                "path": "src/shared/cframeTrack/Point.lua"
            }
        },
        {
            "name": "fromInstance",
            "desc": "Creates from an Instance\n### Children\n```ts\n{\n\tPosition: CFrameInstance,\n}\n```",
            "params": [
                {
                    "name": "instance",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Result<PointCFrameTrack, string>"
                }
            ],
            "function_type": "static",
            "tags": [
                "Constructor"
            ],
            "source": {
                "line": 53,
                "path": "src/shared/cframeTrack/Point.lua"
            }
        },
        {
            "name": "getCFrame",
            "desc": "Returns a CFrame",
            "params": [
                {
                    "name": "position",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "CFrame"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 74,
                "path": "src/shared/cframeTrack/Point.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "length",
            "desc": "Set to 0",
            "lua_type": "number",
            "source": {
                "line": 17,
                "path": "src/shared/cframeTrack/Point.lua"
            }
        },
        {
            "name": "isCircuited",
            "desc": "Set to `false`",
            "lua_type": "boolean",
            "source": {
                "line": 21,
                "path": "src/shared/cframeTrack/Point.lua"
            }
        }
    ],
    "types": [],
    "name": "PointCFrameTrack",
    "desc": "Single CFrame position track.",
    "source": {
        "line": 13,
        "path": "src/shared/cframeTrack/Point.lua"
    }
}