HPL3/SOMA/Scripting/Scripting Api/PhysicsSlideDoor

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	PhysicsSlideDoor_AutoMoveToState(const tString &in asName, int alState) Automove physics slide door to a state
bool	PhysicsSlideDoor_GetClosed(const tString &in asName) Returns true if door is closed
float	PhysicsSlideDoor_GetOpenAmount(const tString &in asName) Returns the open amount of the door
void	PhysicsSlideDoor_SetLocked(const tString &in asName, bool abLocked, bool abEffects) Sets the physics slide door as locked or unlocked

Function Detail

PhysicsSlideDoor_AutoMoveToState

void PhysicsSlideDoor_AutoMoveToState(const tString &in asName,
                                      int alState)

Automove physics slide door to a state.

Parameters

• asName (tString) — name of the door.
• alState (int) — -1=closed, 1= open

Returns:

• void

PhysicsSlideDoor_GetClosed

bool PhysicsSlideDoor_GetClosed(const tString &in asName)

Returns true if door is closed.

Parameters

• asName (tString) — name of the door.

Returns:

• bool—

PhysicsSlideDoor_GetOpenAmount

float PhysicsSlideDoor_GetOpenAmount(const tString &in asName)

Returns the open amount of the door

Parameters

• asName (tString) — name of the door.

Returns:

• float—

PhysicsSlideDoor_SetLocked

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

Sets the physics slide door as locked or unlocked

Parameters

• asName (tString) — name of the door.
• abLocked (bool) — true = lock the door - false = unlock the door
• abEffects (bool) — true = use effects - false = do not use effects.

Returns:

• void