Skip to main content

CFrameTrainConnector

Properties​

index​

</>
CFrameTrainConnector.index: number

frontCarIndex​

</>
CFrameTrainConnector.frontCarIndex: number

rearCarIndex​

</>
CFrameTrainConnector.rearCarIndex: number

offset​

</>
CFrameTrainConnector.offset: CFrame

origin​

</>
CFrameTrainConnector.origin: CFrame

Functions​

new​

Constructor
</>
CFrameTrainConnector.new() → ()

Default constructor

fromData​

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

Constructs from data

fromInstance​

Constructor
</>
CFrameTrainConnector.fromInstance(
instance: Instance,
cars: any,
baseCFrame: CFrame?
) → Result<CFrameTrainConnector,string>

Constructs from an Instance

Destroy​

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

Deconstructor

getCFrame​

</>
CFrameTrainConnector:getCFrame(
frontConnectorCFrame: CFrame,
rearConnectorCFrame: CFrame
) → CFrame

Returns the CFrame position of the connector

getCFrameFromWheelSetCFrames​

</>
CFrameTrainConnector:getCFrameFromWheelSetCFrames(
cars: {CFrameTrainCar},
wheelSetCFrames: {CFrame}
) → any

Gets the CFrame of the Connector from car CFrames

getCFrameFromCarCFrames​

</>
CFrameTrainConnector:getCFrameFromCarCFrames(carCFramesList: any) → CFrame

Gets CFrame from CarCFrames

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Default constructor",
            "params": [],
            "returns": [],
            "function_type": "static",
            "tags": [
                "Constructor"
            ],
            "source": {
                "line": 33,
                "path": "src/shared/animationModel/trainModel/cframeTrain/CFrameTrainConnector.lua"
            }
        },
        {
            "name": "fromData",
            "desc": "Constructs from data",
            "params": [
                {
                    "name": "data",
                    "desc": "",
                    "lua_type": "table"
                }
            ],
            "returns": [],
            "function_type": "static",
            "tags": [
                "Constructor"
            ],
            "source": {
                "line": 50,
                "path": "src/shared/animationModel/trainModel/cframeTrain/CFrameTrainConnector.lua"
            }
        },
        {
            "name": "fromInstance",
            "desc": "Constructs from an Instance",
            "params": [
                {
                    "name": "instance",
                    "desc": "",
                    "lua_type": "Instance"
                },
                {
                    "name": "cars",
                    "desc": "",
                    "lua_type": "any"
                },
                {
                    "name": "baseCFrame",
                    "desc": "",
                    "lua_type": "CFrame?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Result<CFrameTrainConnector, string>"
                }
            ],
            "function_type": "static",
            "tags": [
                "Constructor"
            ],
            "source": {
                "line": 70,
                "path": "src/shared/animationModel/trainModel/cframeTrain/CFrameTrainConnector.lua"
            }
        },
        {
            "name": "Destroy",
            "desc": "Deconstructor",
            "params": [],
            "returns": [],
            "function_type": "method",
            "tags": [
                "Deconstructor"
            ],
            "source": {
                "line": 151,
                "path": "src/shared/animationModel/trainModel/cframeTrain/CFrameTrainConnector.lua"
            }
        },
        {
            "name": "getCFrame",
            "desc": "Returns the CFrame position of the connector",
            "params": [
                {
                    "name": "frontConnectorCFrame",
                    "desc": "",
                    "lua_type": "CFrame"
                },
                {
                    "name": "rearConnectorCFrame",
                    "desc": "",
                    "lua_type": "CFrame"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "CFrame"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 159,
                "path": "src/shared/animationModel/trainModel/cframeTrain/CFrameTrainConnector.lua"
            }
        },
        {
            "name": "getCFrameFromWheelSetCFrames",
            "desc": "Gets the CFrame of the Connector from car CFrames",
            "params": [
                {
                    "name": "cars",
                    "desc": "",
                    "lua_type": "{CFrameTrainCar}"
                },
                {
                    "name": "wheelSetCFrames",
                    "desc": "",
                    "lua_type": "{CFrame}"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 178,
                "path": "src/shared/animationModel/trainModel/cframeTrain/CFrameTrainConnector.lua"
            }
        },
        {
            "name": "getCFrameFromCarCFrames",
            "desc": "Gets CFrame from CarCFrames",
            "params": [
                {
                    "name": "carCFramesList",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "CFrame"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 202,
                "path": "src/shared/animationModel/trainModel/cframeTrain/CFrameTrainConnector.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "index",
            "desc": "",
            "lua_type": "number",
            "source": {
                "line": 15,
                "path": "src/shared/animationModel/trainModel/cframeTrain/CFrameTrainConnector.lua"
            }
        },
        {
            "name": "frontCarIndex",
            "desc": "",
            "lua_type": "number",
            "source": {
                "line": 18,
                "path": "src/shared/animationModel/trainModel/cframeTrain/CFrameTrainConnector.lua"
            }
        },
        {
            "name": "rearCarIndex",
            "desc": "",
            "lua_type": "number",
            "source": {
                "line": 21,
                "path": "src/shared/animationModel/trainModel/cframeTrain/CFrameTrainConnector.lua"
            }
        },
        {
            "name": "offset",
            "desc": "",
            "lua_type": "CFrame",
            "source": {
                "line": 24,
                "path": "src/shared/animationModel/trainModel/cframeTrain/CFrameTrainConnector.lua"
            }
        },
        {
            "name": "origin",
            "desc": "",
            "lua_type": "CFrame",
            "source": {
                "line": 27,
                "path": "src/shared/animationModel/trainModel/cframeTrain/CFrameTrainConnector.lua"
            }
        }
    ],
    "types": [],
    "name": "CFrameTrainConnector",
    "desc": "",
    "source": {
        "line": 12,
        "path": "src/shared/animationModel/trainModel/cframeTrain/CFrameTrainConnector.lua"
    }
}