Class SimulationStateBuilder

Builds a SimulationState for use with all Physics simulation functions

Default:

gravity: 7.5
friction: 0.15

Required to set:

from BasePhysicsSimulationState

cframeTrack: CFrameTrack
- cframeTrack's name will be used for this trackName unless overwritten
trackSectionsData: TrackSectionsData

Hierarchy

physicsSimulator.SimulationStateBuilder
- SimulationStateBuilder

Implements

Partial<physicsSimulator.v1.SimulationState>

Constructors

constructor

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

Properties

`Optional` cframeTrack

cframeTrack?: CFrameTrack

clampPositionToTrackLength

clampPositionToTrackLength: boolean

`Optional` currentPosition

currentPosition?: number

friction

friction: number

gravity

gravity: 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

updateType

updateType: PhysicsUpdateTypeData

Methods

withStopPosition

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

withStopPositions

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

withStopWhenDirectionChanges

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

withTimeInterval

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

withTrackName

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

withTrackSectionsData

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

withUpdateType

withUpdateType(updateType: PhysicsUpdateTypeData): physicsSimulator.v1.SimulationStateBuilder
Parameters
- updateType: PhysicsUpdateTypeData
Returns physicsSimulator.v1.SimulationStateBuilder
- Defined in src/physicsSimulator/v1/simulationStateBuilder.ts:67

Class SimulationStateBuilder

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns physicsSimulator.v1.SimulationStateBuilder

Properties

Optional cframeTrack

clampPositionToTrackLength

Optional currentPosition

friction

gravity

hasPassedTrackEnd

isValleying

isValleyingRange

maxSimulationTime

maxValleyTime

modelDirection

stopPositions

stopWhenDirectionChanges

timeInterval

timeValleying

Optional trackName

Optional trackSectionsData

updateType

Methods

build

Returns Result<physicsSimulator.v1.SimulationState, string>

withCFrameTrack

Parameters

track: CFrameTrack

Returns physicsSimulator.v1.SimulationStateBuilder

withClampPositionToTrackLength

Parameters

value: boolean

Returns physicsSimulator.v1.SimulationStateBuilder

withCurrentPosition

Parameters

position: number

Returns physicsSimulator.v1.SimulationStateBuilder

withFriction

Parameters

friction: number

Returns physicsSimulator.v1.SimulationStateBuilder

withGravity

Parameters

gravity: number

Returns physicsSimulator.v1.SimulationStateBuilder

withHasPassedTrackEnd

Parameters

value: boolean

Returns physicsSimulator.v1.SimulationStateBuilder

withMaxSimulationTime

Parameters

value: number

Returns physicsSimulator.v1.SimulationStateBuilder

withMaxValleyTime

Parameters

value: number

Returns physicsSimulator.v1.SimulationStateBuilder

withModelDirection

Parameters

direction: boolean

Returns physicsSimulator.v1.SimulationStateBuilder

withStopPosition

Parameters

position: number

Optional name: string

Optional shouldStopExactly: boolean

Returns physicsSimulator.v1.SimulationStateBuilder

withStopPositions

Parameters

stopPositions: StopPosition[]

Returns physicsSimulator.v1.SimulationStateBuilder

withStopWhenDirectionChanges

Parameters

`Optional` cframeTrack

`Optional` currentPosition

`Optional` trackName

`Optional` trackSectionsData

`Optional` name: string

`Optional` shouldStopExactly: boolean

`Optional` value: boolean