Skip to main content

CFramedTrainModel

Extends AnimationModel

Train Model

Children

{
	ModelType: StringValue, // set to CFramedTrain
	MidPoint: NumberValue,
	Cars: Instance,
	Connectors: Instance,
}

Properties​

cframeTrain​

</>
CFramedTrainModel.cframeTrain: CFrameTrain

cars​

</>
CFramedTrainModel.cars: {CFramedCarModel}

connectors​

</>
CFramedTrainModel.connectors: {Model}

Functions​

new​

</>
CFramedTrainModel.new(model: Model) → CFramedTrainModel

Constructor

create​

</>
CFramedTrainModel.create(model: Model) → Result<CFramedTrainModel,string>

Constructor

Destroy​

</>
CFramedTrainModel:Destroy() → ()

Deconstructor

setWheelSetPositions​

</>
CFramedTrainModel:setWheelSetPositions(wheelSetPositions: {CFrame}) → ()

SetWheelSetPositions

setInDefaultPosition​

</>
CFramedTrainModel:setInDefaultPosition() → ()

Sets this in the default position

update​

override
</>
CFramedTrainModel:update(
position: number,
modelDirection: boolean,
currentTrack: CFrameTrack?
) → ()

Updates

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructor",
            "params": [
                {
                    "name": "model",
                    "desc": "",
                    "lua_type": "Model"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "CFramedTrainModel"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 51,
                "path": "src/shared/animationModel/trainModel/CFramedTrainModel.lua"
            }
        },
        {
            "name": "create",
            "desc": "Constructor",
            "params": [
                {
                    "name": "model",
                    "desc": "",
                    "lua_type": "Model"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Result<CFramedTrainModel, string>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 66,
                "path": "src/shared/animationModel/trainModel/CFramedTrainModel.lua"
            }
        },
        {
            "name": "Destroy",
            "desc": "Deconstructor",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 105,
                "path": "src/shared/animationModel/trainModel/CFramedTrainModel.lua"
            }
        },
        {
            "name": "setWheelSetPositions",
            "desc": "SetWheelSetPositions",
            "params": [
                {
                    "name": "wheelSetPositions",
                    "desc": "",
                    "lua_type": "{CFrame}"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 111,
                "path": "src/shared/animationModel/trainModel/CFramedTrainModel.lua"
            }
        },
        {
            "name": "setInDefaultPosition",
            "desc": "Sets this in the default position",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 129,
                "path": "src/shared/animationModel/trainModel/CFramedTrainModel.lua"
            }
        },
        {
            "name": "update",
            "desc": "Updates",
            "params": [
                {
                    "name": "position",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "modelDirection",
                    "desc": "",
                    "lua_type": "boolean"
                },
                {
                    "name": "currentTrack",
                    "desc": "",
                    "lua_type": "CFrameTrack?"
                }
            ],
            "returns": [],
            "function_type": "method",
            "tags": [
                "override"
            ],
            "source": {
                "line": 149,
                "path": "src/shared/animationModel/trainModel/CFramedTrainModel.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "cframeTrain",
            "desc": "",
            "lua_type": "CFrameTrain",
            "source": {
                "line": 37,
                "path": "src/shared/animationModel/trainModel/CFramedTrainModel.lua"
            }
        },
        {
            "name": "cars",
            "desc": "",
            "lua_type": "{CFramedCarModel}",
            "source": {
                "line": 40,
                "path": "src/shared/animationModel/trainModel/CFramedTrainModel.lua"
            }
        },
        {
            "name": "connectors",
            "desc": "",
            "lua_type": "{Model}",
            "source": {
                "line": 43,
                "path": "src/shared/animationModel/trainModel/CFramedTrainModel.lua"
            }
        }
    ],
    "types": [],
    "name": "CFramedTrainModel",
    "desc": "##### Extends [AnimationModel](/api/AnimationModel)\nTrain Model\n### Children\n```ts\n{\n\tModelType: StringValue, // set to CFramedTrain\n\tMidPoint: NumberValue,\n\tCars: Instance,\n\tConnectors: Instance,\n}\n```",
    "source": {
        "line": 33,
        "path": "src/shared/animationModel/trainModel/CFramedTrainModel.lua"
    }
}