Skip to main content

CFrameTrackModule

Module for CFrameTrack

Functions​

clampToTrackLength​

</>
CFrameTrackModule.clampToTrackLength(
position: number,
length: number,
isCircuited: boolean?
) → number--

resulting position

Clamps the given position in range of [0, length] or [0, length) if isCircuited. Includes length unlike modulus.

getHasPassedTrackEnd​

</>
CFrameTrackModule.getHasPassedTrackEnd(
position: number,
length: number,
isCircuited: boolean?
) → (
Option<boolean>,--

Direction position passed track end

number--

resulting clamped position

)

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

createFromInstance​

</>
CFrameTrackModule.createFromInstance(instance: Instance) → Result<CFrameTrack,string>

Creates a CFrameTrack from an Instance. Returns a Result.

  • Note: Instance must have a StringValue named TrackClass!
  • Info on how to construct an Instance for each track is located in the .fromInstance constructor docs of each class.

Valid TrackClass Values

Value CFrameTrack
PointToPoint PointToPointCFrameTrack
PointToPoint2 PointToPoint2CFrameTrack
Hinge HingeCFrameTrack
MovingSection MovingSectionCFrameTrack
LerpedPoints LerpedPointsCFrameTrack
TweenedPoints TweenedPointsCFrameTrack
Offset OffsetCFrameTrack
Point PointCFrameTrack
RobloxAnimation RobloxAnimationCFrameTrack
RobloxAnimationPose RobloxAnimationPoseCFrameTrack

isInstance​

</>
CFrameTrackModule.isInstance(instance: Instance) → Result<boolean,string>

Checks if Instance contains a StringValue named "TrackClass"

Show raw api
{
    "functions": [
        {
            "name": "clampToTrackLength",
            "desc": "Clamps the given position in range of [0, length] or [0, length) if `isCircuited`.\nIncludes length unlike modulus.",
            "params": [
                {
                    "name": "position",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "length",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "isCircuited",
                    "desc": "",
                    "lua_type": "boolean?"
                }
            ],
            "returns": [
                {
                    "desc": "resulting position",
                    "lua_type": "number"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 53,
                "path": "src/shared/cframeTrack/init.lua"
            }
        },
        {
            "name": "getHasPassedTrackEnd",
            "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"
                },
                {
                    "name": "length",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "isCircuited",
                    "desc": "",
                    "lua_type": "boolean?"
                }
            ],
            "returns": [
                {
                    "desc": "Direction position passed track end",
                    "lua_type": "Option<boolean>"
                },
                {
                    "desc": "resulting clamped position",
                    "lua_type": "number"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 64,
                "path": "src/shared/cframeTrack/init.lua"
            }
        },
        {
            "name": "createFromInstance",
            "desc": "Creates a CFrameTrack from an Instance.\nReturns a Result.\n- *Note:* Instance must have a `StringValue` named `TrackClass`!\n- Info on how to construct an Instance for each track is located in the .fromInstance constructor docs of each class.\n### Valid TrackClass Values\n| Value | CFrameTrack |\n| ---------- | -------- |\n| `PointToPoint` | [PointToPointCFrameTrack](/api/PointToPointCFrameTrack) |\n| `PointToPoint2` | [PointToPoint2CFrameTrack](/api/PointToPoint2CFrameTrack) |\n| `Hinge` | [HingeCFrameTrack](/api/HingeCFrameTrack) |\n| `MovingSection` | [MovingSectionCFrameTrack](/api/MovingSectionCFrameTrack) |\n| `LerpedPoints` | [LerpedPointsCFrameTrack](/api/LerpedPointsCFrameTrack) |\n| `TweenedPoints` | [TweenedPointsCFrameTrack](/api/TweenedPointsCFrameTrack) |\n| `Offset` | [OffsetCFrameTrack](/api/OffsetCFrameTrack) |\n| `Point` | [PointCFrameTrack](/api/PointCFrameTrack) |\n| `RobloxAnimation` | [RobloxAnimationCFrameTrack](/api/RobloxAnimationCFrameTrack) |\n| `RobloxAnimationPose` | [RobloxAnimationPoseCFrameTrack](/api/RobloxAnimationPoseCFrameTrack) |",
            "params": [
                {
                    "name": "instance",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Result<CFrameTrack, string>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 104,
                "path": "src/shared/cframeTrack/init.lua"
            }
        },
        {
            "name": "isInstance",
            "desc": "Checks if Instance contains a StringValue named \"TrackClass\"",
            "params": [
                {
                    "name": "instance",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Result<boolean, string>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 133,
                "path": "src/shared/cframeTrack/init.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "CFrameTrackModule",
    "desc": "Module for CFrameTrack",
    "source": {
        "line": 30,
        "path": "src/shared/cframeTrack/init.lua"
    }
}