https://wiki.frictionalgames.com/page?action=history&feed=atom&title=HPL3%2FSOMA%2FScripting%2FScripting_Api%2FButtonHPL3/SOMA/Scripting/Scripting Api/Button - Revision history2026-05-02T13:57:00ZRevision history for this page on the wikiMediaWiki 1.34.2https://wiki.frictionalgames.com/page?title=HPL3/SOMA/Scripting/Scripting_Api/Button&diff=5012&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:45:58Z<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|[[#Button_Blink|Button_Blink]](const [[../../tString|tString]] &in asName)|Makes the button blink in accordance to how it is set up in the ent file}}<br />
{{CodeDocSummaryItem|bool|[[#Button_IsDisabled|Button_IsDisabled]](const [[../../tString|tString]] &in asName)|Checks if the button is disabled (will not light up or respond to presses)}}<br />
{{CodeDocSummaryItem|bool|[[#Button_IsLocked|Button_IsLocked]](const [[../../tString|tString]] &in asName)|Checks if the button is locked}}<br />
{{CodeDocSummaryItem|bool|[[#Button_IsSwitchedOn|Button_IsSwitchedOn]](const [[../../tString|tString]] &in asName)|Returns true if button is currently switched on}}<br />
{{CodeDocSummaryItem|void|[[#Button_SetCanBeSwitchedOff|Button_SetCanBeSwitchedOff]](const [[../../tString|tString]] &in asName, bool abState)|Sets if the button can be switched off by the player or not}}<br />
{{CodeDocSummaryItem|void|[[#Button_SetCanBeSwitchedOn|Button_SetCanBeSwitchedOn]](const [[../../tString|tString]] &in asName, bool abState)|Sets if the button can be switched on by the player or not}}<br />
{{CodeDocSummaryItem|void|[[#Button_SetDisabled|Button_SetDisabled]](const [[../../tString|tString]] &in asName, bool abState, bool abUseEffects <nowiki>=</nowiki> true)|Sets the buttons disabled state}}<br />
{{CodeDocSummaryItem|void|[[#Button_SetLocked|Button_SetLocked]](const [[../../tString|tString]] &in asName, bool abState, bool abUseEffects <nowiki>=</nowiki> true)|Sets the button's locked state}}<br />
{{CodeDocSummaryItem|void|[[#Button_SetSwitchedOn|Button_SetSwitchedOn]](const [[../../tString|tString]] &in asName, bool abState, bool abEffects)|Switches a button on/off}}<br />
{{CodeDocSummaryBottom}}<br />
<br />
==Function Detail==<br />
{{CodeDocDetailTop|Button_Blink}}<br />
<syntaxhighlight lang="c++">void Button_Blink(const tString &in asName)</syntaxhighlight><br />
{{CodeDocDetailBody|Makes the button blink in accordance to how it is set up in the ent file.}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asName|[[../../tString|tString]]|name of button.}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|Button_IsDisabled}}<br />
<syntaxhighlight lang="c++">bool Button_IsDisabled(const tString &in asName)</syntaxhighlight><br />
{{CodeDocDetailBody|Checks if the button is disabled (will not light up or respond to presses).}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asName|[[../../tString|tString]]|name of button.}}<br />
{{CodeDocDetailReturn|bool|true <nowiki>=</nowiki> disabled, false <nowiki>=</nowiki> enabled.}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|Button_IsLocked}}<br />
<syntaxhighlight lang="c++">bool Button_IsLocked(const tString &in asName)</syntaxhighlight><br />
{{CodeDocDetailBody|Checks if the button is locked.}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asName|[[../../tString|tString]]|name of button.}}<br />
{{CodeDocDetailReturn|bool|true <nowiki>=</nowiki> locked, false <nowiki>=</nowiki> unlocked.}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|Button_IsSwitchedOn}}<br />
<syntaxhighlight lang="c++">bool Button_IsSwitchedOn(const tString &in asName)</syntaxhighlight><br />
{{CodeDocDetailBody|Returns true if button is currently switched on.}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asName|[[../../tString|tString]]|name of button.}}<br />
{{CodeDocDetailReturn|bool|if the button is switched on.}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|Button_SetCanBeSwitchedOff}}<br />
<syntaxhighlight lang="c++">void Button_SetCanBeSwitchedOff(const tString &in asName,<br />
bool abState)</syntaxhighlight><br />
{{CodeDocDetailBody|Sets if the button can be switched off by the player or not}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asName|[[../../tString|tString]]|name of button.}}<br />
{{CodeDocDetailParam|abState|bool|true <nowiki>=</nowiki> can be switched off - false <nowiki>=</nowiki> can't be switched off.}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|Button_SetCanBeSwitchedOn}}<br />
<syntaxhighlight lang="c++">void Button_SetCanBeSwitchedOn(const tString &in asName,<br />
bool abState)</syntaxhighlight><br />
{{CodeDocDetailBody|Sets if the button can be switched on by the player or not}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asName|[[../../tString|tString]]|name of button.}}<br />
{{CodeDocDetailParam|abState|bool|true <nowiki>=</nowiki> can be switched on - false <nowiki>=</nowiki> can't be switched on.}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|Button_SetDisabled}}<br />
<syntaxhighlight lang="c++">void Button_SetDisabled(const tString &in asName,<br />
bool abState,<br />
bool abUseEffects = true)</syntaxhighlight><br />
{{CodeDocDetailBody|Sets the buttons disabled state}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asName|[[../../tString|tString]]|name of button.}}<br />
{{CodeDocDetailParam|abState|bool|true <nowiki>=</nowiki> disabled, false <nowiki>=</nowiki> not disabled}}<br />
{{CodeDocDetailParam|abUseEffects|bool|if color should fade in or be set instantly.}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|Button_SetLocked}}<br />
<syntaxhighlight lang="c++">void Button_SetLocked(const tString &in asName,<br />
bool abState,<br />
bool abUseEffects = true)</syntaxhighlight><br />
{{CodeDocDetailBody|Sets the button's locked state}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asName|[[../../tString|tString]]|name of button.}}<br />
{{CodeDocDetailParam|abState|bool|true <nowiki>=</nowiki> locked, false <nowiki>=</nowiki> unlocked.}}<br />
{{CodeDocDetailParam|abUseEffects|bool|if color should fade in or be set instantly.}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|Button_SetSwitchedOn}}<br />
<syntaxhighlight lang="c++">void Button_SetSwitchedOn(const tString &in asName,<br />
bool abState,<br />
bool abEffects)</syntaxhighlight><br />
{{CodeDocDetailBody|Switches a button on/off.<br/>the change will not be apparent to the player.}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asName|[[../../tString|tString]]|name of button.}}<br />
{{CodeDocDetailParam|abState|bool|true <nowiki>=</nowiki> on - false <nowiki>=</nowiki> off.}}<br />
{{CodeDocDetailParam|abEffects|bool|if the change should activate effects associated with it. If false,}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}</div>Abion47