https://wiki.frictionalgames.com/page?action=history&feed=atom&title=HPL3%2FAmnesia%3A_Rebirth%2FScripting%2FScripting_Api%2FLight HPL3/Amnesia: Rebirth/Scripting/Scripting Api/Light - Revision history 2026-05-14T06:44:37Z Revision history for this page on the wiki MediaWiki 1.34.2 https://wiki.frictionalgames.com/page?title=HPL3/Amnesia:_Rebirth/Scripting/Scripting_Api/Light&diff=6160&oldid=prev Abion47: 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:05:11Z <p>Created page with &quot;{{ScriptingStub}} Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki! ==Summary== {{CodeDocSummaryTop}} {{CodeDocSummaryIte...&quot;</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|[[#Light_FadeBrightnessTo|Light_FadeBrightnessTo]](const [[../../tString|tString]] &amp;in asLightName, float afBrightness, float afTime, [[../../eEasing|eEasing]] aEasing &lt;nowiki&gt;=&lt;/nowiki&gt; eEasing_Linear)|Fades the brightness of one or more lights to a specified value}}<br /> {{CodeDocSummaryItem|void|[[#Light_FadeBrightnessToDefault|Light_FadeBrightnessToDefault]](const [[../../tString|tString]] &amp;in asLightName, float afTime, [[../../eEasing|eEasing]] aEasing &lt;nowiki&gt;=&lt;/nowiki&gt; eEasing_Linear)|Fades the brightness of one or more lights to a the default value}}<br /> {{CodeDocSummaryItem|void|[[#Light_FadeTo|Light_FadeTo]](const [[../../tString|tString]] &amp;in asLightName, const [[../../cColor|cColor]] &amp;in acColor, float afRadius, float afTime)|Fades one or more lights to a specified color and radius}}<br /> {{CodeDocSummaryItem|float|[[#Light_GetBrightness|Light_GetBrightness]](const [[../../tString|tString]] &amp;in asLightName)|Gets the brightness of a light}}<br /> {{CodeDocSummaryItem|float|[[#Light_GetDefaultBrightness|Light_GetDefaultBrightness]](const [[../../tString|tString]] &amp;in asLightName)|Returns the default brightness of a light}}<br /> {{CodeDocSummaryItem|void|[[#Light_SetBrightness|Light_SetBrightness]](const [[../../tString|tString]] &amp;in asLightName, float afBrightness)|Sets the brightness of one or more lights}}<br /> {{CodeDocSummaryItem|void|[[#Light_SetCastShadows|Light_SetCastShadows]](const [[../../tString|tString]] &amp;in asLightName, bool abX)|Sets the casts shadow}}<br /> {{CodeDocSummaryItem|void|[[#Light_SetCheapGobo|Light_SetCheapGobo]](const [[../../tString|tString]] &amp;in asLightName, bool abX)|Sets if a cheaper version of gobo rendering should be used}}<br /> {{CodeDocSummaryItem|void|[[#Light_SetFlickerActive|Light_SetFlickerActive]](const [[../../tString|tString]] &amp;in asLightName, bool abX)|Activates or deactivates the flicker of one or more lights}}<br /> {{CodeDocSummaryItem|void|[[#Light_SetShadowBiasMul|Light_SetShadowBiasMul]](const [[../../tString|tString]] &amp;in asLightName, float afBias, float afSlopeBias)|Sets the shadow bias for one or more lights}}<br /> {{CodeDocSummaryItem|void|[[#Light_SetupFlicker|Light_SetupFlicker]](const [[../../tString|tString]] &amp;in asLightName, const [[../../cColor|cColor]] &amp;in aOffCol, float afOffRadius, float afOnMinLength, float afOnMaxLength, const [[../../tString|tString]] &amp;in asOnSound, const [[../../tString|tString]] &amp;in asOnPS, float afOffMinLength, float afOffMaxLength, const [[../../tString|tString]] &amp;in asOffSound, const [[../../tString|tString]] &amp;in asOffPS, bool abFade, float afOnFadeMinLength, float afOnFadeMaxLength, float afOffFadeMinLength, float afOffFadeMaxLength)|Set up the flicker of one or more lights}}<br /> {{CodeDocSummaryItem|void|[[#Light_SetVisible|Light_SetVisible]](const [[../../tString|tString]] &amp;in asLightName, bool abVisible)|Sets the visibility of one or more lights}}<br /> {{CodeDocSummaryBottom}}<br /> <br /> ==Function Detail==<br /> {{CodeDocDetailTop|Light_FadeBrightnessTo}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;void Light_FadeBrightnessTo(const tString &amp;in asLightName,<br /> float afBrightness,<br /> float afTime,<br /> eEasing aEasing = eEasing_Linear)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|Fades the brightness of one or more lights to a specified value.}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|asLightName|[[../../tString|tString]]|}}<br /> {{CodeDocDetailParam|afBrightness|float|}}<br /> {{CodeDocDetailParam|afTime|float|}}<br /> {{CodeDocDetailParam|aEasing|[[../../eEasing|eEasing]]|}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|Light_FadeBrightnessToDefault}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;void Light_FadeBrightnessToDefault(const tString &amp;in asLightName,<br /> float afTime,<br /> eEasing aEasing = eEasing_Linear)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|Fades the brightness of one or more lights to a the default value.}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|asLightName|[[../../tString|tString]]|}}<br /> {{CodeDocDetailParam|afTime|float|}}<br /> {{CodeDocDetailParam|aEasing|[[../../eEasing|eEasing]]|}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|Light_FadeTo}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;void Light_FadeTo(const tString &amp;in asLightName,<br /> const cColor &amp;in acColor,<br /> float afRadius,<br /> float afTime)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|Fades one or more lights to a specified color and radius.}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|asLightName|[[../../tString|tString]]|}}<br /> {{CodeDocDetailParam|acColor|[[../../cColor|cColor]]|}}<br /> {{CodeDocDetailParam|afRadius|float|}}<br /> {{CodeDocDetailParam|afTime|float|}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|Light_GetBrightness}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;float Light_GetBrightness(const tString &amp;in asLightName)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|Gets the brightness of a light}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|asLightName|[[../../tString|tString]]|}}<br /> {{CodeDocDetailReturn|float|float, the brightness of the light}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|Light_GetDefaultBrightness}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;float Light_GetDefaultBrightness(const tString &amp;in asLightName)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|Returns the default brightness of a light}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|asLightName|[[../../tString|tString]]|}}<br /> {{CodeDocDetailReturn|float|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|Light_SetBrightness}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;void Light_SetBrightness(const tString &amp;in asLightName,<br /> float afBrightness)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|Sets the brightness of one or more lights}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|asLightName|[[../../tString|tString]]|}}<br /> {{CodeDocDetailParam|afBrightness|float|}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|Light_SetCastShadows}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;void Light_SetCastShadows(const tString &amp;in asLightName,<br /> bool abX)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|Sets the casts shadow. Used only by spotlights (for now).}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|asLightName|[[../../tString|tString]]|}}<br /> {{CodeDocDetailParam|abX|bool|}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|Light_SetCheapGobo}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;void Light_SetCheapGobo(const tString &amp;in asLightName,<br /> bool abX)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|Sets if a cheaper version of gobo rendering should be used}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|asLightName|[[../../tString|tString]]|}}<br /> {{CodeDocDetailParam|abX|bool|}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|Light_SetFlickerActive}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;void Light_SetFlickerActive(const tString &amp;in asLightName,<br /> bool abX)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|Activates or deactivates the flicker of one or more lights}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|asLightName|[[../../tString|tString]]|}}<br /> {{CodeDocDetailParam|abX|bool|}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|Light_SetShadowBiasMul}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;void Light_SetShadowBiasMul(const tString &amp;in asLightName,<br /> float afBias,<br /> float afSlopeBias)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|Sets the shadow bias for one or more lights}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|asLightName|[[../../tString|tString]]|}}<br /> {{CodeDocDetailParam|afBias|float|}}<br /> {{CodeDocDetailParam|afSlopeBias|float|}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|Light_SetupFlicker}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;void Light_SetupFlicker(const tString &amp;in asLightName,<br /> const cColor &amp;in aOffCol,<br /> float afOffRadius,<br /> float afOnMinLength,<br /> float afOnMaxLength,<br /> const tString &amp;in asOnSound,<br /> const tString &amp;in asOnPS,<br /> float afOffMinLength,<br /> float afOffMaxLength,<br /> const tString &amp;in asOffSound,<br /> const tString &amp;in asOffPS,<br /> bool abFade,<br /> float afOnFadeMinLength,<br /> float afOnFadeMaxLength,<br /> float afOffFadeMinLength,<br /> float afOffFadeMaxLength)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|Set up the flicker of one or more lights}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|asLightName|[[../../tString|tString]]|}}<br /> {{CodeDocDetailParam|aOffCol|[[../../cColor|cColor]]|}}<br /> {{CodeDocDetailParam|afOffRadius|float|}}<br /> {{CodeDocDetailParam|afOnMinLength|float|}}<br /> {{CodeDocDetailParam|afOnMaxLength|float|}}<br /> {{CodeDocDetailParam|asOnSound|[[../../tString|tString]]|}}<br /> {{CodeDocDetailParam|asOnPS|[[../../tString|tString]]|}}<br /> {{CodeDocDetailParam|afOffMinLength|float|}}<br /> {{CodeDocDetailParam|afOffMaxLength|float|}}<br /> {{CodeDocDetailParam|asOffSound|[[../../tString|tString]]|}}<br /> {{CodeDocDetailParam|asOffPS|[[../../tString|tString]]|}}<br /> {{CodeDocDetailParam|abFade|bool|}}<br /> {{CodeDocDetailParam|afOnFadeMinLength|float|}}<br /> {{CodeDocDetailParam|afOnFadeMaxLength|float|}}<br /> {{CodeDocDetailParam|afOffFadeMinLength|float|}}<br /> {{CodeDocDetailParam|afOffFadeMaxLength|float|}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|Light_SetVisible}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;void Light_SetVisible(const tString &amp;in asLightName,<br /> bool abVisible)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|Sets the visibility of one or more lights}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|asLightName|[[../../tString|tString]]|}}<br /> {{CodeDocDetailParam|abVisible|bool|}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}</div> Abion47