Class CFrameTrain

Hierarchy

CFrameTrain

Index

Constructors

Properties

baseCFrame cars connectors length wheelSetOffsets wheelSetOffsetsBackwards

Methods

getCFrames default fromInstance getCarsFromInstance getConnectorsFromInstance getWheelSetOffsetsFromCars updateWheelSetIndexes

Constructors

constructor

new CFrameTrain(): CFrameTrain
Returns CFrameTrain
- Defined in src/cframeTrain/cframeTrain.ts:65

Properties

baseCFrame

baseCFrame: CFrame

cars

cars: CFrameTrainCar[]

connectors

connectors: Map<string, CFrameTrainConnector>

length

length: number

wheelSetOffsets

wheelSetOffsets: number[]

wheelSetOffsetsBackwards

wheelSetOffsetsBackwards: number[]

Methods

getCFrames

getCFrames(wheelSetCFrames: CFrame[]): TrainCFrameData
Parameters
- wheelSetCFrames: CFrame[]
Returns TrainCFrameData
- Defined in src/cframeTrain/cframeTrain.ts:453

`Static` default

default(this: void): CFrameTrain
Parameters
- this: void
Returns CFrameTrain
- Defined in src/cframeTrain/cframeTrain.ts:76

`Static` fromInstance

fromInstance(this: void, instance: Instance): Result<CFrameTrain, string>
Parameters
- this: void
- instance: Instance
Returns Result<CFrameTrain, string>
- Defined in src/cframeTrain/cframeTrain.ts:130

`Static` getCarsFromInstance

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

`Static` getConnectorsFromInstance

getConnectorsFromInstance(instance: Instance, cars: CFrameTrainCar[], baseCFrame?: CFrame): Result<Map<string, CFrameTrainConnector>, string>
Parameters
- instance: Instance
- cars: CFrameTrainCar[]
- Optional baseCFrame: CFrame
Returns Result<Map<string, CFrameTrainConnector>, string>
- Defined in src/cframeTrain/cframeTrain.ts:307

`Static` getWheelSetOffsetsFromCars

getWheelSetOffsetsFromCars(this: void, cars: CFrameTrainCar[]): number[]
Parameters
- this: void
- cars: CFrameTrainCar[]
Returns number[]
- Defined in src/cframeTrain/cframeTrain.ts:408

`Static` updateWheelSetIndexes

updateWheelSetIndexes(this: void, cars: CFrameTrainCar[]): void
Parameters
- this: void
- cars: CFrameTrainCar[]
Returns void
- Defined in src/cframeTrain/cframeTrain.ts:380

Generated using TypeDoc