Skip to main content

OffsetCFrameTrack

Offsets the returned CFrame from the root track

Properties​

rootTrack​

</>
OffsetCFrameTrack.rootTrack: CFrameTrack

offset​

</>
OffsetCFrameTrack.offset: CFrame

length​

</>
OffsetCFrameTrack.length: number

Set to rootTrack.length

isCircuited​

</>
OffsetCFrameTrack.isCircuited: boolean

Set to rootTrack.isCircuited

Functions​

new​

Constructor
</>
OffsetCFrameTrack.new(
rootTrack: CFrameTrack,
offset: CFrame?
) → OffsetCFrameTrack

Constructor

fromInstance​

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

Creates from an Instance

Children

{
	RootTrack: CFrameTrackInstance | ObjectValue<CFrameTrackInstance>,
	Offset: CFrameOffsetInstance,
}

getCFrame​

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

Returns a CFrame

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructor",
            "params": [
                {
                    "name": "rootTrack",
                    "desc": "",
                    "lua_type": "CFrameTrack"
                },
                {
                    "name": "offset",
                    "desc": "",
                    "lua_type": "CFrame?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "OffsetCFrameTrack"
                }
            ],
            "function_type": "static",
            "tags": [
                "Constructor"
            ],
            "source": {
                "line": 39,
                "path": "src/shared/cframeTrack/Offset.lua"
            }
        },
        {
            "name": "fromInstance",
            "desc": "Creates from an Instance\n### Children\n```ts\n{\n\tRootTrack: CFrameTrackInstance | ObjectValue<CFrameTrackInstance>,\n\tOffset: CFrameOffsetInstance,\n}\n```",
            "params": [
                {
                    "name": "instance",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Result<MovingSectionCFrameTrack, string>"
                }
            ],
            "function_type": "static",
            "tags": [
                "Constructor"
            ],
            "source": {
                "line": 65,
                "path": "src/shared/cframeTrack/Offset.lua"
            }
        },
        {
            "name": "getCFrame",
            "desc": "Returns a CFrame",
            "params": [
                {
                    "name": "position",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "CFrame"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 110,
                "path": "src/shared/cframeTrack/Offset.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "rootTrack",
            "desc": "",
            "lua_type": "CFrameTrack",
            "source": {
                "line": 18,
                "path": "src/shared/cframeTrack/Offset.lua"
            }
        },
        {
            "name": "offset",
            "desc": "",
            "lua_type": "CFrame",
            "source": {
                "line": 21,
                "path": "src/shared/cframeTrack/Offset.lua"
            }
        },
        {
            "name": "length",
            "desc": "Set to `rootTrack.length`",
            "lua_type": "number",
            "source": {
                "line": 25,
                "path": "src/shared/cframeTrack/Offset.lua"
            }
        },
        {
            "name": "isCircuited",
            "desc": "Set to `rootTrack.isCircuited`",
            "lua_type": "boolean",
            "source": {
                "line": 29,
                "path": "src/shared/cframeTrack/Offset.lua"
            }
        }
    ],
    "types": [],
    "name": "OffsetCFrameTrack",
    "desc": "Offsets the returned CFrame from the root track",
    "source": {
        "line": 15,
        "path": "src/shared/cframeTrack/Offset.lua"
    }
}