HPL3/SOMA/Scripting/Scripting Api/Slide

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
void	Slide_AutoMoveTo(const tString &in asName, float afAmount) Auto moves the slide prop to a specific amount?
bool	Slide_GetLocked(const tString &in asName) Get if the slide prop is locked
float	Slide_GetSlideAmount(const tString &in asName) Gets the slide amount of a Slide prop, 0 being at it' min position and 1 being at its max
cVector3f	Slide_GetSlideVel(const tString &in asName) Gets the velocity of the slide joint
void	Slide_SetLocked(const tString &in asName, bool abLocked, bool abEffects) Locks/Unlocks a slide prop
void	Slide_SetSlideAmount(const tString &in asName, float afAmount) Sets the slide amount of a Slide prop, 0 being at it' min position and 1 being at its max

Function Detail

Slide_AutoMoveTo

void Slide_AutoMoveTo(const tString &in asName,
                      float afAmount)

Auto moves the slide prop to a specific amount?

Parameters

• asName (tString) — name of the prop.
• afAmount (float) — the slide amount to set.

Returns:

• void

Slide_GetLocked

bool Slide_GetLocked(const tString &in asName)

Get if the slide prop is locked.

Parameters

• asName (tString) — name of the prop.

Returns:

• bool—

Slide_GetSlideAmount

float Slide_GetSlideAmount(const tString &in asName)

Gets the slide amount of a Slide prop, 0 being at it' min position and 1 being at its max.

Parameters

• asName (tString) — name of the prop.

Returns:

• float—the slide amount.

Slide_GetSlideVel

cVector3f Slide_GetSlideVel(const tString &in asName)

Gets the velocity of the slide joint.

Parameters

• asName (tString) — name of the prop.

Returns:

• cVector3f—the vel of the slide joint.

Slide_SetLocked

void Slide_SetLocked(const tString &in asName,
                     bool abLocked,
                     bool abEffects)

Locks/Unlocks a slide prop.

Parameters

• asName (tString) — name of the prop.
• abLocked (bool) — if the slide prop should be locked or not.
• abEffects (bool) — if sounds and any other effects associated with locking/unlocking should be activated

Returns:

• void

Slide_SetSlideAmount

void Slide_SetSlideAmount(const tString &in asName,
                          float afAmount)

Sets the slide amount of a Slide prop, 0 being at it' min position and 1 being at its max.

Parameters

• asName (tString) — name of the prop.
• afAmount (float) — the slide amount to set.

Returns:

• void