https://wiki.frictionalgames.com/page?action=history&feed=atom&title=HPL3%2FSOMA%2FScripting%2FScripting_Api%2FLight HPL3/SOMA/Scripting/Scripting Api/Light - Revision history 2026-05-02T11:40:01Z Revision history for this page on the wiki MediaWiki 1.34.2 https://wiki.frictionalgames.com/page?title=HPL3/SOMA/Scripting/Scripting_Api/Light&diff=5038&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-08-24T20:55:54Z <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_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|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_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_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]]|name of light. Can contain wildcards.}}<br /> {{CodeDocDetailParam|acColor|[[../../cColor|cColor]]|color to fade to.}}<br /> {{CodeDocDetailParam|afRadius|float|radius to fade to, if lower than 0, the current radius will be used.}}<br /> {{CodeDocDetailParam|afTime|float|time to fade over.}}<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]]|name of light.}}<br /> {{CodeDocDetailReturn|float|the brightness of the light}}<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]]|name of light. Can contain wildcards.}}<br /> {{CodeDocDetailParam|afBrightness|float|the brightness to set.}}<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]]|name of the light. Can contain wildcards.}}<br /> {{CodeDocDetailParam|abX|bool|if light should cast shadows.}}<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]]|name of light. Can contain wildcards.}}<br /> {{CodeDocDetailParam|abX|bool|if cheap version should be used, off by default}}<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]]|name of light. Can contain wildcards.}}<br /> {{CodeDocDetailParam|abX|bool|if flicker should be active.}}<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]]|name of light. Can contain wildcards.}}<br /> {{CodeDocDetailParam|afBias|float|bias mul}}<br /> {{CodeDocDetailParam|afSlopeBias|float|slope bias mul}}<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]]|name of light. Can contain wildcards.}}<br /> {{CodeDocDetailParam|abVisible|bool|if light should be visible.}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}</div> Abion47