HPL3/SOMA/Scripting/Scripting Api/SlideDoor

From Frictional Wiki
< HPL3‎ | SOMA‎ | Scripting‎ | Scripting Api
Jump to navigation Jump to search
Info icon.png

This page has been automatically generated, but it needs descriptions added to the various fields/functions in order to be complete.

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) — name of the door.

Returns:

  • 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) — name of the door.
  • abClosed (bool) — true = close - false = open
  • abInstant (bool) — if the door should slide to the correct state or just have the

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) — name of the door.
  • abX (bool) — if possible to open or not.

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) — name of the door.
  • afOpenAmount (float) — the open amount to set
  • abInstant (bool) — if the door should slide to the correct state or just have the

Returns:

  • void
Retrieved from "https://wiki.frictionalgames.com/page?title=HPL3/SOMA/Scripting/Scripting_Api/SlideDoor&oldid=5050"