Skip to main content

CFrameTrainCar

Types​

CFrameCalculationType​

enum
</>
interface CFrameCalculationType {
FromWheelSetA: 0
BetweenFrontCar: 1
BetweenRearCar: 2
BetweenWheelSets: 3
}

Properties​

index​

</>
CFrameTrainCar.index: number

wheelSetAIndex​

</>
CFrameTrainCar.wheelSetAIndex: number

wheelSetBIndex​

</>
CFrameTrainCar.wheelSetBIndex: number

cframeCalculation​

</>
CFrameTrainCar.cframeCalculation: number

hasWheelSetB​

</>
CFrameTrainCar.hasWheelSetB: boolean

chassisOrigin​

</>
CFrameTrainCar.chassisOrigin: CFrame

wheelSetAOrigin​

</>
CFrameTrainCar.wheelSetAOrigin: CFrame

wheelSetBOrigin​

</>
CFrameTrainCar.wheelSetBOrigin: CFrame

offsetBetweenWheelSets​

</>
CFrameTrainCar.offsetBetweenWheelSets: CFrame

offsetFromWheelSetA​

</>
CFrameTrainCar.offsetFromWheelSetA: CFrame

offsetBetweenFrontCar​

</>
CFrameTrainCar.offsetBetweenFrontCar: CFrame

offsetBetweenRearCar​

</>
CFrameTrainCar.offsetBetweenRearCar: CFrame

frontConnectorOffset​

</>
CFrameTrainCar.frontConnectorOffset: CFrame

rearConnectorOffset​

</>
CFrameTrainCar.rearConnectorOffset: CFrame

Functions​

new​

Constructor
</>
CFrameTrainCar.new() → CFrameTrainCar

Default constructor

fromData​

Constructor
</>
CFrameTrainCar.fromData(data: table) → CFrameTrainCar

fromData Constructor

fromInstance​

Constructor
</>
CFrameTrainCar.fromInstance(
instance: Instance,
baseCFrame: CFrame
) → Result<CFrameTrainCar,string>

Destroy​

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

Deconstructor

setWheelSetIndexes​

</>
CFrameTrainCar:setWheelSetIndexes(
aIndex: number,
bIndex: number?
) → ()

Sets WheelSetIndexes

updateCarOffsets​

</>
CFrameTrainCar:updateCarOffsets(
frontCar: CFrameTrainCar,
rearCar: CFrameTrainCar
) → ()

Updates the offsets of the cars

getRearWheelSetOrigin​

</>
CFrameTrainCar:getRearWheelSetOrigin() → CFrame

Gets the origin of the rearmost WheelSet

getCFrames​

</>
CFrameTrainCar:getCFrames(
wheelSetAOrigin: CFrame,
wheelSetBOrigin: CFrame,
frontWheelSetCFrame: CFrame,
rearWheelSetCFrame: CFrame
) → (
CFrame,--

chassis

CFrame,--

frontConnector

CFrame--

rearConnector

)

Gets the CFrames

getWheelSetCFrames​

</>
CFrameTrainCar:getWheelSetCFrames(wheelSetCFrames: {CFrame}) → (
CFrame,--

wheelSetACFrame

CFrame | nil,--

wheelSetBCFrame

CFrame,--

frontWheelSetCFrame

CFrame | nil--

rearWheelSetCFrame

)

Gets the CFrame from WheelSet's indexes

getCFramesFromWheelSetCFrames​

</>
CFrameTrainCar:getCFramesFromWheelSetCFrames(wheelSetCFrames: {CFrame}) → (
CFrame,--

chassis

CFrame,--

frontConnector

CFrame--

rearConnector

)

Gets the CFrames

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Default constructor",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "CFrameTrainCar"
                }
            ],
            "function_type": "static",
            "tags": [
                "Constructor"
            ],
            "source": {
                "line": 87,
                "path": "src/shared/animationModel/trainModel/cframeTrain/CFrameTrainCar.lua"
            }
        },
        {
            "name": "fromData",
            "desc": "fromData Constructor",
            "params": [
                {
                    "name": "data",
                    "desc": "",
                    "lua_type": "table"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "CFrameTrainCar"
                }
            ],
            "function_type": "static",
            "tags": [
                "Constructor"
            ],
            "source": {
                "line": 117,
                "path": "src/shared/animationModel/trainModel/cframeTrain/CFrameTrainCar.lua"
            }
        },
        {
            "name": "fromInstance",
            "desc": "",
            "params": [
                {
                    "name": "instance",
                    "desc": "",
                    "lua_type": "Instance"
                },
                {
                    "name": "baseCFrame",
                    "desc": "",
                    "lua_type": "CFrame"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Result<CFrameTrainCar, string>"
                }
            ],
            "function_type": "static",
            "tags": [
                "Constructor"
            ],
            "source": {
                "line": 164,
                "path": "src/shared/animationModel/trainModel/cframeTrain/CFrameTrainCar.lua"
            }
        },
        {
            "name": "Destroy",
            "desc": "Deconstructor",
            "params": [],
            "returns": [],
            "function_type": "method",
            "tags": [
                "Deconstructor"
            ],
            "source": {
                "line": 269,
                "path": "src/shared/animationModel/trainModel/cframeTrain/CFrameTrainCar.lua"
            }
        },
        {
            "name": "setWheelSetIndexes",
            "desc": "Sets WheelSetIndexes",
            "params": [
                {
                    "name": "aIndex",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "bIndex",
                    "desc": "",
                    "lua_type": "number?"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 276,
                "path": "src/shared/animationModel/trainModel/cframeTrain/CFrameTrainCar.lua"
            }
        },
        {
            "name": "updateCarOffsets",
            "desc": "Updates the offsets of the cars",
            "params": [
                {
                    "name": "frontCar",
                    "desc": "",
                    "lua_type": "CFrameTrainCar"
                },
                {
                    "name": "rearCar",
                    "desc": "",
                    "lua_type": "CFrameTrainCar"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 284,
                "path": "src/shared/animationModel/trainModel/cframeTrain/CFrameTrainCar.lua"
            }
        },
        {
            "name": "getRearWheelSetOrigin",
            "desc": "Gets the origin of the rearmost WheelSet",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "CFrame"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 305,
                "path": "src/shared/animationModel/trainModel/cframeTrain/CFrameTrainCar.lua"
            }
        },
        {
            "name": "getCFrames",
            "desc": "Gets the CFrames",
            "params": [
                {
                    "name": "wheelSetAOrigin",
                    "desc": "",
                    "lua_type": "CFrame"
                },
                {
                    "name": "wheelSetBOrigin",
                    "desc": "",
                    "lua_type": "CFrame"
                },
                {
                    "name": "frontWheelSetCFrame",
                    "desc": "",
                    "lua_type": "CFrame"
                },
                {
                    "name": "rearWheelSetCFrame",
                    "desc": "",
                    "lua_type": "CFrame"
                }
            ],
            "returns": [
                {
                    "desc": "chassis",
                    "lua_type": "CFrame"
                },
                {
                    "desc": "frontConnector",
                    "lua_type": "CFrame"
                },
                {
                    "desc": "rearConnector",
                    "lua_type": "CFrame"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 321,
                "path": "src/shared/animationModel/trainModel/cframeTrain/CFrameTrainCar.lua"
            }
        },
        {
            "name": "getWheelSetCFrames",
            "desc": "Gets the CFrame from WheelSet's indexes",
            "params": [
                {
                    "name": "wheelSetCFrames",
                    "desc": "",
                    "lua_type": "{CFrame}"
                }
            ],
            "returns": [
                {
                    "desc": "wheelSetACFrame",
                    "lua_type": "CFrame"
                },
                {
                    "desc": "wheelSetBCFrame",
                    "lua_type": "CFrame | nil"
                },
                {
                    "desc": "frontWheelSetCFrame",
                    "lua_type": "CFrame"
                },
                {
                    "desc": "rearWheelSetCFrame",
                    "lua_type": "CFrame | nil"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 369,
                "path": "src/shared/animationModel/trainModel/cframeTrain/CFrameTrainCar.lua"
            }
        },
        {
            "name": "getCFramesFromWheelSetCFrames",
            "desc": "Gets the CFrames",
            "params": [
                {
                    "name": "wheelSetCFrames",
                    "desc": "",
                    "lua_type": "{CFrame}"
                }
            ],
            "returns": [
                {
                    "desc": "chassis",
                    "lua_type": "CFrame"
                },
                {
                    "desc": "frontConnector",
                    "lua_type": "CFrame"
                },
                {
                    "desc": "rearConnector",
                    "lua_type": "CFrame"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 399,
                "path": "src/shared/animationModel/trainModel/cframeTrain/CFrameTrainCar.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "index",
            "desc": "",
            "lua_type": "number",
            "source": {
                "line": 41,
                "path": "src/shared/animationModel/trainModel/cframeTrain/CFrameTrainCar.lua"
            }
        },
        {
            "name": "wheelSetAIndex",
            "desc": "",
            "lua_type": "number",
            "source": {
                "line": 44,
                "path": "src/shared/animationModel/trainModel/cframeTrain/CFrameTrainCar.lua"
            }
        },
        {
            "name": "wheelSetBIndex",
            "desc": "",
            "lua_type": "number",
            "source": {
                "line": 47,
                "path": "src/shared/animationModel/trainModel/cframeTrain/CFrameTrainCar.lua"
            }
        },
        {
            "name": "cframeCalculation",
            "desc": "",
            "lua_type": "number",
            "source": {
                "line": 50,
                "path": "src/shared/animationModel/trainModel/cframeTrain/CFrameTrainCar.lua"
            }
        },
        {
            "name": "hasWheelSetB",
            "desc": "",
            "lua_type": "boolean",
            "source": {
                "line": 53,
                "path": "src/shared/animationModel/trainModel/cframeTrain/CFrameTrainCar.lua"
            }
        },
        {
            "name": "chassisOrigin",
            "desc": "",
            "lua_type": "CFrame",
            "source": {
                "line": 56,
                "path": "src/shared/animationModel/trainModel/cframeTrain/CFrameTrainCar.lua"
            }
        },
        {
            "name": "wheelSetAOrigin",
            "desc": "",
            "lua_type": "CFrame",
            "source": {
                "line": 59,
                "path": "src/shared/animationModel/trainModel/cframeTrain/CFrameTrainCar.lua"
            }
        },
        {
            "name": "wheelSetBOrigin",
            "desc": "",
            "lua_type": "CFrame",
            "source": {
                "line": 62,
                "path": "src/shared/animationModel/trainModel/cframeTrain/CFrameTrainCar.lua"
            }
        },
        {
            "name": "offsetBetweenWheelSets",
            "desc": "",
            "lua_type": "CFrame",
            "source": {
                "line": 65,
                "path": "src/shared/animationModel/trainModel/cframeTrain/CFrameTrainCar.lua"
            }
        },
        {
            "name": "offsetFromWheelSetA",
            "desc": "",
            "lua_type": "CFrame",
            "source": {
                "line": 68,
                "path": "src/shared/animationModel/trainModel/cframeTrain/CFrameTrainCar.lua"
            }
        },
        {
            "name": "offsetBetweenFrontCar",
            "desc": "",
            "lua_type": "CFrame",
            "source": {
                "line": 71,
                "path": "src/shared/animationModel/trainModel/cframeTrain/CFrameTrainCar.lua"
            }
        },
        {
            "name": "offsetBetweenRearCar",
            "desc": "",
            "lua_type": "CFrame",
            "source": {
                "line": 74,
                "path": "src/shared/animationModel/trainModel/cframeTrain/CFrameTrainCar.lua"
            }
        },
        {
            "name": "frontConnectorOffset",
            "desc": "",
            "lua_type": "CFrame",
            "source": {
                "line": 77,
                "path": "src/shared/animationModel/trainModel/cframeTrain/CFrameTrainCar.lua"
            }
        },
        {
            "name": "rearConnectorOffset",
            "desc": "",
            "lua_type": "CFrame",
            "source": {
                "line": 80,
                "path": "src/shared/animationModel/trainModel/cframeTrain/CFrameTrainCar.lua"
            }
        }
    ],
    "types": [
        {
            "name": "CFrameCalculationType",
            "desc": "",
            "fields": [
                {
                    "name": "FromWheelSetA",
                    "lua_type": "0",
                    "desc": ""
                },
                {
                    "name": "BetweenFrontCar",
                    "lua_type": "1",
                    "desc": ""
                },
                {
                    "name": "BetweenRearCar",
                    "lua_type": "2",
                    "desc": ""
                },
                {
                    "name": "BetweenWheelSets",
                    "lua_type": "3",
                    "desc": ""
                }
            ],
            "tags": [
                "enum"
            ],
            "source": {
                "line": 19,
                "path": "src/shared/animationModel/trainModel/cframeTrain/CFrameTrainCar.lua"
            }
        }
    ],
    "name": "CFrameTrainCar",
    "desc": "",
    "source": {
        "line": 38,
        "path": "src/shared/animationModel/trainModel/cframeTrain/CFrameTrainCar.lua"
    }
}