HPL3/SOMA/Scripting/Scripting Api/Wheel

Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!

Summary

Return Type	Function and Description
float	Wheel_GetCurrentAngle(const tString &in asName) Gets the angle of a wheel
int	Wheel_GetState(const tString &in asName) Gets the state of the wheel
void	Wheel_SetAngle(const tString &in asName, float afAngle, bool abAutoMove) Sets the angle of a wheel
void	Wheel_SetInteractionDisablesStuck(const tString &in asName, bool abX) Sets if player interaction will disable the stuck state of a wheel
void	Wheel_SetStuckState(const tString &in asName, int alState, bool abEffects) Sets the stuck state of a wheel

Function Detail

Wheel_GetCurrentAngle

float Wheel_GetCurrentAngle(const tString &in asName)

Gets the angle of a wheel.

Parameters

• asName (tString) — name of wheel.

Returns:

• float—angle in radians

Wheel_GetState

int Wheel_GetState(const tString &in asName)

Gets the state of the wheel

Parameters

• asName (tString) — name of wheel.

Returns:

• int—-1 = min, 0 = middle, 1 = max

Wheel_SetAngle

void Wheel_SetAngle(const tString &in asName,
                    float afAngle,
                    bool abAutoMove)

Sets the angle of a wheel.

Parameters

• asName (tString) — name of wheel.
• afAngle (float) — angle to set in radians.
• abAutoMove (bool) — if the wheel should move to the angle automatically.

Returns:

• void

Wheel_SetInteractionDisablesStuck

void Wheel_SetInteractionDisablesStuck(const tString &in asName,
                                       bool abX)

Sets if player interaction will disable the stuck state of a wheel.
effect on stuck state.

Parameters

• asName (tString) — name of wheel.
• abX (bool) — true = interaction disables stuck state - false = interaction has no

Returns:

• void

Wheel_SetStuckState

void Wheel_SetStuckState(const tString &in asName,
                         int alState,
                         bool abEffects)

Sets the stuck state of a wheel.
the change will not be apparent to the player.

Parameters

• asName (tString) — name of wheel.
• alState (int) — stuck state where -1 = stuck at min, 1 = stuck at max and 0 = not stuck.
• abEffects (bool) — if the change should activate effects associated with it. If false,

Returns:

• void