Class CFrameTrainConnector

Hierarchy

CFrameTrainConnector

Index

Constructors

Properties

frontCarIndex name offset origin rearCarIndex

Methods

getCFrame getCFrameFromCarCFrames getCFrameFromWheelSetCFrames fromInstance

Constructors

constructor

new CFrameTrainConnector(): CFrameTrainConnector
Returns CFrameTrainConnector
- Defined in src/cframeTrain/cframeTrainConnector.ts:44

Properties

frontCarIndex

frontCarIndex: number

name

name: string

offset

offset: CFrame

origin

origin: CFrame

rearCarIndex

rearCarIndex: number

Methods

getCFrame

getCFrame(frontConnectorCFrame: undefined | CFrame, rearConnectorCFrame: undefined | CFrame): CFrame
Parameters
- frontConnectorCFrame: undefined | CFrame
- rearConnectorCFrame: undefined | CFrame
Returns CFrame
- Defined in src/cframeTrain/cframeTrainConnector.ts:168

getCFrameFromCarCFrames

getCFrameFromCarCFrames(carCFramesList: CarCFrameData[]): CFrame
Parameters
- carCFramesList: CarCFrameData[]
Returns CFrame
- Defined in src/cframeTrain/cframeTrainConnector.ts:221

getCFrameFromWheelSetCFrames

getCFrameFromWheelSetCFrames(cars: CFrameTrainCar[], wheelSetCFrames: CFrame[]): CFrame
Parameters
- cars: CFrameTrainCar[]
- wheelSetCFrames: CFrame[]
Returns CFrame
- Defined in src/cframeTrain/cframeTrainConnector.ts:189

`Static` fromInstance

fromInstance(this: void, instance: Instance, cars: CFrameTrainCar[], baseCFrame?: CFrame): Result<CFrameTrainConnector, string>
Parameters
- this: void
- instance: Instance
- cars: CFrameTrainCar[]
- Optional baseCFrame: CFrame
Returns Result<CFrameTrainConnector, string>
- Defined in src/cframeTrain/cframeTrainConnector.ts:74

Generated using TypeDoc