Difference between revisions of "HPL3/Amnesia: Rebirth/Scripting/Scripting Api/PhysicsSlideDoor"

From Frictional Wiki
Jump to navigation Jump to search
(Created page with "{{ScriptingStub}} Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki! ==Summary== {{CodeDocSummaryTop}} {{CodeDocSummaryIte...")
 
(No difference)

Latest revision as of 01:06, 16 November 2020

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
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) —
  • alState (int) —

Returns:

  • void

PhysicsSlideDoor_GetClosed

bool PhysicsSlideDoor_GetClosed(const tString &in asName)

Returns true if door is closed.

Parameters

Returns:

  • bool—

PhysicsSlideDoor_GetOpenAmount

float PhysicsSlideDoor_GetOpenAmount(const tString &in asName)

Returns the open amount of the door

Parameters

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) —
  • abLocked (bool) —
  • abEffects (bool) —

Returns:

  • void
Retrieved from "https://wiki.frictionalgames.com/page?title=HPL3/Amnesia:_Rebirth/Scripting/Scripting_Api/PhysicsSlideDoor&oldid=6169"