https://wiki.frictionalgames.com/page?action=history&feed=atom&title=HPL3%2FSOMA%2FScripting%2FScripting_Api%2FSwingDoorHPL3/SOMA/Scripting/Scripting Api/SwingDoor - Revision history2026-05-02T15:55:57ZRevision history for this page on the wikiMediaWiki 1.34.2https://wiki.frictionalgames.com/page?title=HPL3/SOMA/Scripting/Scripting_Api/SwingDoor&diff=5052&oldid=prevAbion47: 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..."2020-08-24T20:59:24Z<p>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..."</p>
<p><b>New page</b></p><div>{{ScriptingStub}}<br />
<br />
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!<br />
<br />
==Summary==<br />
{{CodeDocSummaryTop}}<br />
{{CodeDocSummaryItem|void|[[#SwingDoor_AddDoorBodyImpulse|SwingDoor_AddDoorBodyImpulse]](const [[../../tString|tString]] &in asName, float afImpulseAmount)|}}<br />
{{CodeDocSummaryItem|bool|[[#SwingDoor_GetBlocked|SwingDoor_GetBlocked]](const [[../../tString|tString]] &in asName)|Checks if door is blocked}}<br />
{{CodeDocSummaryItem|bool|[[#SwingDoor_GetClosed|SwingDoor_GetClosed]](const [[../../tString|tString]] &in asName)|Checks if door is closed}}<br />
{{CodeDocSummaryItem|bool|[[#SwingDoor_GetLocked|SwingDoor_GetLocked]](const [[../../tString|tString]] &in asName)|Checks if door is locked}}<br />
{{CodeDocSummaryItem|float|[[#SwingDoor_GetOpenAmount|SwingDoor_GetOpenAmount]](const [[../../tString|tString]] &in asName)|Get open amount of a door}}<br />
{{CodeDocSummaryItem|int|[[#SwingDoor_GetState|SwingDoor_GetState]](const [[../../tString|tString]] &in asName)|Checks the state of the door}}<br />
{{CodeDocSummaryItem|void|[[#SwingDoor_SetBlocked|SwingDoor_SetBlocked]](const [[../../tString|tString]] &in asName, bool abBlocked, bool abEffects)|Blocks or unblocks a SwingDoor}}<br />
{{CodeDocSummaryItem|void|[[#SwingDoor_SetClosed|SwingDoor_SetClosed]](const [[../../tString|tString]] &in asName, bool abClosed, bool abEffects)|Sets the close state of a SwingDoor}}<br />
{{CodeDocSummaryItem|void|[[#SwingDoor_SetDisableAutoClose|SwingDoor_SetDisableAutoClose]](const [[../../tString|tString]] &in asName, bool abDisableAutoClose)|Disables or enables the automatic close functionality of a door}}<br />
{{CodeDocSummaryItem|void|[[#SwingDoor_SetLocked|SwingDoor_SetLocked]](const [[../../tString|tString]] &in asName, bool abLocked, bool abEffects)|Locks or unlocks a SwingDoor}}<br />
{{CodeDocSummaryItem|void|[[#SwingDoor_SetOpenAmount|SwingDoor_SetOpenAmount]](const [[../../tString|tString]] &in asName, float afOpenAmount)|Sets the door to a specific open state instantly}}<br />
{{CodeDocSummaryBottom}}<br />
<br />
==Function Detail==<br />
{{CodeDocDetailTop|SwingDoor_AddDoorBodyImpulse}}<br />
<syntaxhighlight lang="c++">void SwingDoor_AddDoorBodyImpulse(const tString &in asName,<br />
float afImpulseAmount)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asName|[[../../tString|tString]]|}}<br />
{{CodeDocDetailParam|afImpulseAmount|float|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SwingDoor_GetBlocked}}<br />
<syntaxhighlight lang="c++">bool SwingDoor_GetBlocked(const tString &in asName)</syntaxhighlight><br />
{{CodeDocDetailBody|Checks if door is blocked.}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asName|[[../../tString|tString]]|name of the door.}}<br />
{{CodeDocDetailReturn|bool|true if the door is blocked.}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SwingDoor_GetClosed}}<br />
<syntaxhighlight lang="c++">bool SwingDoor_GetClosed(const tString &in asName)</syntaxhighlight><br />
{{CodeDocDetailBody|Checks if door is closed.}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asName|[[../../tString|tString]]|name of the door.}}<br />
{{CodeDocDetailReturn|bool|true if the door is closed.}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SwingDoor_GetLocked}}<br />
<syntaxhighlight lang="c++">bool SwingDoor_GetLocked(const tString &in asName)</syntaxhighlight><br />
{{CodeDocDetailBody|Checks if door is locked.}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asName|[[../../tString|tString]]|name of the door.}}<br />
{{CodeDocDetailReturn|bool|true if the door is locked.}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SwingDoor_GetOpenAmount}}<br />
<syntaxhighlight lang="c++">float SwingDoor_GetOpenAmount(const tString &in asName)</syntaxhighlight><br />
{{CodeDocDetailBody|Get open amount of a door}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asName|[[../../tString|tString]]|name of the door.}}<br />
{{CodeDocDetailReturn|float|open amount of door}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SwingDoor_GetState}}<br />
<syntaxhighlight lang="c++">int SwingDoor_GetState(const tString &in asName)</syntaxhighlight><br />
{{CodeDocDetailBody|Checks the state of the door.<br/>0 <nowiki>=</nowiki> inbetween -1 and 1.}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asName|[[../../tString|tString]]|name of the door.}}<br />
{{CodeDocDetailReturn|int|-1 <nowiki>=</nowiki> angle is close to 0, 1 <nowiki>=</nowiki> angle is 70% or higher of max,}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SwingDoor_SetBlocked}}<br />
<syntaxhighlight lang="c++">void SwingDoor_SetBlocked(const tString &in asName,<br />
bool abBlocked,<br />
bool abEffects)</syntaxhighlight><br />
{{CodeDocDetailBody|Blocks or unblocks a SwingDoor. A blocked door can still be opened slightly.<br/>If false, the change will not be apparent to the player.}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asName|[[../../tString|tString]]|name of the door, wildcards (*) supported.}}<br />
{{CodeDocDetailParam|abBlocked|bool|true <nowiki>=</nowiki> block door, false <nowiki>=</nowiki> unblock door.}}<br />
{{CodeDocDetailParam|abEffects|bool|if the change should activate effects associated with it.}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SwingDoor_SetClosed}}<br />
<syntaxhighlight lang="c++">void SwingDoor_SetClosed(const tString &in asName,<br />
bool abClosed,<br />
bool abEffects)</syntaxhighlight><br />
{{CodeDocDetailBody|Sets the close state of a SwingDoor.<br/>If false, the change will not be apparent to the player.}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asName|[[../../tString|tString]]|name of the door, wildcards (*) supported.}}<br />
{{CodeDocDetailParam|abClosed|bool|true <nowiki>=</nowiki> close - false <nowiki>=</nowiki> open}}<br />
{{CodeDocDetailParam|abEffects|bool|if the change should activate effects associated with it.}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SwingDoor_SetDisableAutoClose}}<br />
<syntaxhighlight lang="c++">void SwingDoor_SetDisableAutoClose(const tString &in asName,<br />
bool abDisableAutoClose)</syntaxhighlight><br />
{{CodeDocDetailBody|Disables or enables the automatic close functionality of a door.<br/>If enabled, the door will not lose any force pushing it toward its closed position.}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asName|[[../../tString|tString]]|name of the door, wildcards (*) supported.}}<br />
{{CodeDocDetailParam|abDisableAutoClose|bool|true <nowiki>=</nowiki> disable - false <nowiki>=</nowiki> enable}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SwingDoor_SetLocked}}<br />
<syntaxhighlight lang="c++">void SwingDoor_SetLocked(const tString &in asName,<br />
bool abLocked,<br />
bool abEffects)</syntaxhighlight><br />
{{CodeDocDetailBody|Locks or unlocks a SwingDoor<br/>If false, the change will not be apparent to the player.}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asName|[[../../tString|tString]]|name of the door, wildcards (*) supported.}}<br />
{{CodeDocDetailParam|abLocked|bool|true <nowiki>=</nowiki> lock door, false <nowiki>=</nowiki> unlock door.}}<br />
{{CodeDocDetailParam|abEffects|bool|if the change should activate effects associated with it.}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SwingDoor_SetOpenAmount}}<br />
<syntaxhighlight lang="c++">void SwingDoor_SetOpenAmount(const tString &in asName,<br />
float afOpenAmount)</syntaxhighlight><br />
{{CodeDocDetailBody|Sets the door to a specific open state instantly.}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asName|[[../../tString|tString]]|name of the door, wildcards (*) supported.}}<br />
{{CodeDocDetailParam|afOpenAmount|float|0 <nowiki>=</nowiki> closed, 1 <nowiki>=</nowiki> completely open.}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}</div>Abion47