Class HingeMotorSimulator

Simulates scripted rotational movement

Designed for dark rides

Hierarchy

HingeMotorSimulator

Index

Constructors

Properties

angle axis cframe hasPassedEnd speed state stateData useNegativeAngle

Methods

getAngleCFrame getKeyframe getKeyframeBuilder lockAngle lookAtAngle lookAtDirection lookAtPosition setAngle setCFrame setCustom setState spin spinAmount spinTo update updateAngle

Constructors

constructor

new HingeMotorSimulator(axis: Axis, cframe?: CFrame): HingeMotorSimulator
Default constructor
Parameters
- axis: Axis
- Optional cframe: CFrame
Returns HingeMotorSimulator
- Defined in src/hingeSimulator/motor/hingeMotor.ts:111

Properties

angle

angle: number

axis

axis: Axis

cframe

cframe: CFrame

hasPassedEnd

hasPassedEnd: Option<boolean>

speed

speed: number

state

state: HingeState

stateData

stateData: HingeStateData

useNegativeAngle

useNegativeAngle: boolean

Methods

getAngleCFrame

getAngleCFrame(): CFrame
Returns CFrame
- Defined in src/hingeSimulator/motor/hingeMotor.ts:152

getKeyframe

getKeyframe(trackName: string, length: number): Result<TrackKeyframe, string>
Returns the current state as a Keyframe
Parameters
- trackName: string
- length: number
Returns Result<TrackKeyframe, string>
- Defined in src/hingeSimulator/motor/hingeMotor.ts:148

getKeyframeBuilder

getKeyframeBuilder(): KeyframeBuilder
Returns the current state as a KeyframeBuilder

Returns KeyframeBuilder
- Defined in src/hingeSimulator/motor/hingeMotor.ts:131

lockAngle

lockAngle(): void
Sets speed to 0 and state to Custom

Returns void
- Defined in src/hingeSimulator/motor/hingeMotor.ts:302

lookAtAngle

lookAtAngle(data: LookAtAngleStateData): Result<true, string>
Looks at the given angle
Parameters
- data: LookAtAngleStateData
Returns Result<true, string>
- Defined in src/hingeSimulator/motor/hingeMotor.ts:312

lookAtDirection

lookAtDirection(data: LookAtDirectionStateData): Result<true, string>
Looks at the unit direction
Parameters
- data: LookAtDirectionStateData
Returns Result<true, string>
- Defined in src/hingeSimulator/motor/hingeMotor.ts:344

lookAtPosition

lookAtPosition(data: LookAtPositionStateData): Result<true, string>
Looks at the position in world space.
Parameters
- data: LookAtPositionStateData
Returns Result<true, string>
- Defined in src/hingeSimulator/motor/hingeMotor.ts:328

setAngle

setAngle(angle: number): void
Sets the angle. Bypasses hasPassedEnd
Parameters
- angle: number
Returns void
- Defined in src/hingeSimulator/motor/hingeMotor.ts:182

setCFrame

setCFrame(cframe: CFrame): void
Sets the world space position of this hinge
Parameters
- cframe: CFrame
Returns void
- Defined in src/hingeSimulator/motor/hingeMotor.ts:173

setCustom

setCustom(): void
Sets state to Custom

Returns void
- Defined in src/hingeSimulator/motor/hingeMotor.ts:294

setState

setState(data: SetHingeStateData): Result<defined, string>
Sets the state of this using the given data
Parameters
- data: SetHingeStateData
Returns Result<defined, string>
- Defined in src/hingeSimulator/motor/hingeMotor.ts:236

spin

spin(data: SpinStateData): Result<true, string>
Spins
Parameters
- data: SpinStateData
Returns Result<true, string>
- Defined in src/hingeSimulator/motor/hingeMotor.ts:360

spinAmount

spinAmount(data: SpinAmountStateData): Result<true, string>
Spins the given amount
Parameters
- data: SpinAmountStateData
Returns Result<true, string>
- Defined in src/hingeSimulator/motor/hingeMotor.ts:376

spinTo

spinTo(data: SpinToStateData): Result<true, string>
Spins to the given angle
Parameters
- data: SpinToStateData
Returns Result<true, string>
- Defined in src/hingeSimulator/motor/hingeMotor.ts:392

update

update(stepped: number): void
Updates this hinge
Parameters
- stepped: number
Returns void
- Defined in src/hingeSimulator/motor/hingeMotor.ts:202

updateAngle

updateAngle(angle: number): void
Updates the angle and flags if it has passed the "track end"
Parameters
- angle: number
Returns void
- Defined in src/hingeSimulator/motor/hingeMotor.ts:189

Generated using TypeDoc