Differences

This shows you the differences between two versions of the page.

--- set_entity_light_enabled [2017/08/11 21:32] – created justin
+++ set_entity_light_enabled [2018/03/16 09:48] – justin
@@ Line 4: / Line 4: @@
 Enables or disables the light attached to the specified entity (with the assumption that the entity is a light source).
+====Signature:====
 <code python>
 set_entity_light_enabled(entity, enabled)
@@ Line 10: / Line 11: @@
 ^Argument^Description^Type^Required^
 |entity|Entity that will have its light enabled or disabled.|[[Entity]]|Yes|
-|enabled|Determines whether the light will be turned on or off.|[[Boolean]]|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:====
@@ Line 16: / Line 21: @@
 set_entity_light_enabled(entity["lamp"], false)
 </code>
-//Results:// The entity with an ID of "lamp" will be disabled (i.e. it will be turned off and no longer cast light until turned on again).
+//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...
+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>

RPG in a BoxOfficial Documentation