RPG in a Box
Official Documentation

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.

======Set Entity Light Enabled======
----

Enables or disables the light attached to the specified entity (with the assumption that the entity is a light source).

<code python>
set_entity_light_enabled(entity, enabled)
</code>

^Argument^Description^Type^Required^
|entity|Entity that will have its light enabled or disabled.|[[Entity]]|Yes|
|enabled|Determines the light's state (on or off).|[[Boolean]]|Yes|

<WRAP center round info 100%>
If you'd like to change the color of the entity's light instead of toggling it on or off, see the related [[Set Entity Light Color]] function.
</WRAP>

====Example:====
<code lua>
set_entity_light_enabled(entity["lamp"], false)
</code>
//Results:// The entity with an ID of "lamp" will have its light disabled (i.e. it will be turned off and no longer cast light until turned on again).

<WRAP center round tip 100%>
Use the **Set Entity Light Enabled** function to toggle a room's light on and off when the player interacts with a switch or button.
</WRAP>

<WRAP group>
<WRAP half column>
====Editor Node:====
{{:wiki:set_entity_light_enabled_node.png?nolink|}}
</WRAP>

<WRAP half column>
====Visual Demo:==== 
{{:wiki:set_entity_light_enabled_demo.gif?nolink|}}
</WRAP>
</WRAP>

~~NOTOC~~

RPG in a BoxOfficial Documentation

User Tools

Site Tools

Page Tools

RPG in a Box
Official Documentation