https://wiki.frictionalgames.com/page?title=HPL3/Amnesia:_Rebirth/Scripting/Scripting_Api/Lamp&feed=atom&action=historyHPL3/Amnesia: Rebirth/Scripting/Scripting Api/Lamp - Revision history2024-03-28T16:30:10ZRevision history for this page on the wikiMediaWiki 1.34.2https://wiki.frictionalgames.com/page?title=HPL3/Amnesia:_Rebirth/Scripting/Scripting_Api/Lamp&diff=6156&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-11-15T23:04:38Z<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|bool|[[#Lamp_GetLit|Lamp_GetLit]](const [[../../tString|tString]] &in asName)|Gets the lit state of a lamp}}<br />
{{CodeDocSummaryItem|void|[[#Lamp_SetFlickerActive|Lamp_SetFlickerActive]](const [[../../tString|tString]] &in asName, bool abActive)|Activates or deactivates flicker on the specified lamp(s)}}<br />
{{CodeDocSummaryItem|void|[[#Lamp_SetLit|Lamp_SetLit]](const [[../../tString|tString]] &in asName, bool abLit, bool abEffects)|Sets the lit state of a lamp}}<br />
{{CodeDocSummaryItem|void|[[#Lamp_SetupFlicker|Lamp_SetupFlicker]](const [[../../tString|tString]] &in asName, float afMinOnTime, float afMaxOnTime, float afMinOffTime, float afMaxOffTime, bool abFade <nowiki>=</nowiki> false, const [[../../tString|tString]] &in asOnSound <nowiki>=</nowiki> "", const [[../../tString|tString]] &in asOffSound <nowiki>=</nowiki> "", const [[../../tString|tString]] &in asOnPS <nowiki>=</nowiki> "", const [[../../tString|tString]] &in asOffPS <nowiki>=</nowiki> "")|Sets the properties of the flicker of a lamp}}<br />
{{CodeDocSummaryBottom}}<br />
<br />
==Function Detail==<br />
{{CodeDocDetailTop|Lamp_GetLit}}<br />
<syntaxhighlight lang="c++">bool Lamp_GetLit(const tString &in asName)</syntaxhighlight><br />
{{CodeDocDetailBody|Gets the lit state of a lamp.}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asName|[[../../tString|tString]]|}}<br />
{{CodeDocDetailReturn|bool|bool, if the lamp is lit.}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|Lamp_SetFlickerActive}}<br />
<syntaxhighlight lang="c++">void Lamp_SetFlickerActive(const tString &in asName,<br />
bool abActive)</syntaxhighlight><br />
{{CodeDocDetailBody|Activates or deactivates flicker on the specified lamp(s)}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asName|[[../../tString|tString]]|}}<br />
{{CodeDocDetailParam|abActive|bool|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|Lamp_SetLit}}<br />
<syntaxhighlight lang="c++">void Lamp_SetLit(const tString &in asName,<br />
bool abLit,<br />
bool abEffects)</syntaxhighlight><br />
{{CodeDocDetailBody|Sets the lit state of a lamp.<br/>If false, the change will not be apparent to the player.}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asName|[[../../tString|tString]]|}}<br />
{{CodeDocDetailParam|abLit|bool|}}<br />
{{CodeDocDetailParam|abEffects|bool|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|Lamp_SetupFlicker}}<br />
<syntaxhighlight lang="c++">void Lamp_SetupFlicker(const tString &in asName,<br />
float afMinOnTime,<br />
float afMaxOnTime,<br />
float afMinOffTime,<br />
float afMaxOffTime,<br />
bool abFade = false,<br />
const tString &in asOnSound = "",<br />
const tString &in asOffSound = "",<br />
const tString &in asOnPS = "",<br />
const tString &in asOffPS = "")</syntaxhighlight><br />
{{CodeDocDetailBody|Sets the properties of the flicker of a lamp.<br/>with setting the lit state of the lamp. Default <nowiki>=</nowiki> false.}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asName|[[../../tString|tString]]|}}<br />
{{CodeDocDetailParam|afMinOnTime|float|}}<br />
{{CodeDocDetailParam|afMaxOnTime|float|}}<br />
{{CodeDocDetailParam|afMinOffTime|float|}}<br />
{{CodeDocDetailParam|afMaxOffTime|float|}}<br />
{{CodeDocDetailParam|abFade|bool|}}<br />
{{CodeDocDetailParam|asOnSound|[[../../tString|tString]]|}}<br />
{{CodeDocDetailParam|asOffSound|[[../../tString|tString]]|}}<br />
{{CodeDocDetailParam|asOnPS|[[../../tString|tString]]|}}<br />
{{CodeDocDetailParam|asOffPS|[[../../tString|tString]]|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}</div>Abion47