HPL3/Amnesia: Rebirth/Scripting/Scripting Api/SlideDoor

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	SlideDoor_GetOpenAmount(const tString &in asName) Gets the open amount of a SlideDoor, 0 being completely closed and 1 being completely open
void	SlideDoor_SetClosed(const tString &in asName, bool abClosed, bool abInstant = false) Sets the close state of a SlideDoor
void	SlideDoor_SetOpenableByAgent(const tString &in asName, bool abX) Sets if the agents should be able to open the slide door
void	SlideDoor_SetOpenAmount(const tString &in asName, float afOpenAmount, bool abInstant = false) Moves a SlideDoor to a specific open amount

Function Detail

SlideDoor_GetOpenAmount

float SlideDoor_GetOpenAmount(const tString &in asName)

Gets the open amount of a SlideDoor, 0 being completely closed and 1 being completely open.

Parameters

• asName (tString) —

Returns:

• float—float, open amount of the door.

SlideDoor_SetClosed

void SlideDoor_SetClosed(const tString &in asName,
                         bool abClosed,
                         bool abInstant = false)

Sets the close state of a SlideDoor. Simplified version of SlideDoor_SetOpenAmount.
new position set instantly.

Parameters

• asName (tString) —
• abClosed (bool) —
• abInstant (bool) —

Returns:

• void

SlideDoor_SetOpenableByAgent

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

Sets if the agents should be able to open the slide door.

Parameters

• asName (tString) —
• abX (bool) —

Returns:

• void

SlideDoor_SetOpenAmount

void SlideDoor_SetOpenAmount(const tString &in asName,
                             float afOpenAmount,
                             bool abInstant = false)

Moves a SlideDoor to a specific open amount.
new position set instantly.

Parameters

• asName (tString) —
• afOpenAmount (float) —
• abInstant (bool) —

Returns:

• void