Class SimulationStateBuilder

Builds a SimulationState for use with all Physics simulation functions

Required to set:

cframeTrack: CFrameTrack
trackSectionsData: TrackSectionsData

from SimulationState:

trackName: string

Hierarchy

recordUtil.SimulationStateBuilder
- SimulationStateBuilder
  - physicsSimulator.v1.SimulationStateBuilder

Implements

Partial<physicsSimulator.SimulationState>

Constructors

constructor

new SimulationStateBuilder(): physicsSimulator.SimulationStateBuilder
Returns physicsSimulator.SimulationStateBuilder
Overrides SimulationStateBuilder.constructor
- Defined in src/physicsSimulator/simulationStateBuilder.ts:34

Properties

`Optional` cframeTrack

cframeTrack?: CFrameTrack

clampPositionToTrackLength

clampPositionToTrackLength: boolean

`Optional` currentPosition

currentPosition?: number

hasPassedTrackEnd

hasPassedTrackEnd: boolean

isValleying

isValleying: boolean

isValleyingRange

isValleyingRange: number

maxSimulationTime

maxSimulationTime: number

maxValleyTime

maxValleyTime: number

modelDirection

modelDirection: boolean

stopPositions

stopPositions: StopPosition[]

stopWhenDirectionChanges

stopWhenDirectionChanges: boolean

timeInterval

timeInterval: number

timeValleying

timeValleying: number

`Optional` trackName

trackName?: string

`Optional` trackSectionsData

trackSectionsData?: TrackSectionsData

Methods

build

build(): Result<physicsSimulator.SimulationState, string>
Returns Result<physicsSimulator.SimulationState, string>
Overrides SimulationStateBuilder.build
- Defined in src/physicsSimulator/simulationStateBuilder.ts:53

withCFrameTrack

withCFrameTrack(track: CFrameTrack): physicsSimulator.SimulationStateBuilder
Parameters
- track: CFrameTrack
Returns physicsSimulator.SimulationStateBuilder
- Defined in src/physicsSimulator/simulationStateBuilder.ts:96

withClampPositionToTrackLength

withClampPositionToTrackLength(value: boolean): physicsSimulator.SimulationStateBuilder
Parameters
- value: boolean
Returns physicsSimulator.SimulationStateBuilder
- Defined in src/physicsSimulator/simulationStateBuilder.ts:106

withCurrentPosition

withCurrentPosition(position: number): physicsSimulator.SimulationStateBuilder
Parameters
- position: number
Returns physicsSimulator.SimulationStateBuilder
Inherited from SimulationStateBuilder.withCurrentPosition
- Defined in src/recordUtil/simulationStateBuilder.ts:45

withHasPassedTrackEnd

withHasPassedTrackEnd(value: boolean): physicsSimulator.SimulationStateBuilder
Parameters
- value: boolean
Returns physicsSimulator.SimulationStateBuilder
Inherited from SimulationStateBuilder.withHasPassedTrackEnd
- Defined in src/recordUtil/simulationStateBuilder.ts:69

withMaxSimulationTime

withMaxSimulationTime(value: number): physicsSimulator.SimulationStateBuilder
Parameters
- value: number
Returns physicsSimulator.SimulationStateBuilder
- Defined in src/physicsSimulator/simulationStateBuilder.ts:150

withMaxValleyTime

withMaxValleyTime(value: number): physicsSimulator.SimulationStateBuilder
Parameters
- value: number
Returns physicsSimulator.SimulationStateBuilder
- Defined in src/physicsSimulator/simulationStateBuilder.ts:144

withModelDirection

withModelDirection(direction: boolean): physicsSimulator.SimulationStateBuilder
Parameters
- direction: boolean
Returns physicsSimulator.SimulationStateBuilder
Inherited from SimulationStateBuilder.withModelDirection
- Defined in src/recordUtil/simulationStateBuilder.ts:51

withStopPosition

withStopPosition(position: number, name?: string, shouldStopExactly?: boolean): physicsSimulator.SimulationStateBuilder
Parameters
- position: number
- Optional name: string
- Optional shouldStopExactly: boolean
Returns physicsSimulator.SimulationStateBuilder
- Defined in src/physicsSimulator/simulationStateBuilder.ts:118

withStopPositions

withStopPositions(stopPositions: StopPosition[]): physicsSimulator.SimulationStateBuilder
Parameters
- stopPositions: StopPosition[]
Returns physicsSimulator.SimulationStateBuilder
- Defined in src/physicsSimulator/simulationStateBuilder.ts:128

withStopWhenDirectionChanges

withStopWhenDirectionChanges(value?: boolean): physicsSimulator.SimulationStateBuilder
Parameters
- Optional value: boolean
Returns physicsSimulator.SimulationStateBuilder
- Defined in src/physicsSimulator/simulationStateBuilder.ts:136

withTimeInterval

withTimeInterval(interval: number): physicsSimulator.SimulationStateBuilder
Parameters
- interval: number
Returns physicsSimulator.SimulationStateBuilder
Inherited from SimulationStateBuilder.withTimeInterval
- Defined in src/recordUtil/simulationStateBuilder.ts:63

withTrackName

withTrackName(name: string): physicsSimulator.SimulationStateBuilder
Parameters
- name: string
Returns physicsSimulator.SimulationStateBuilder
Inherited from SimulationStateBuilder.withTrackName
- Defined in src/recordUtil/simulationStateBuilder.ts:57

withTrackSectionsData

withTrackSectionsData(data: TrackSectionsData): physicsSimulator.SimulationStateBuilder
Parameters
- data: TrackSectionsData
Returns physicsSimulator.SimulationStateBuilder
- Defined in src/physicsSimulator/simulationStateBuilder.ts:112

Generated using TypeDoc