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 Group Light Enabled======
----

Enables or disables the light attached to any entities in the specified group (with the assumption that each entity is a light source).

<code python>
set_group_light_enabled(group_name, enabled)
</code>

^Argument^Description^Type^Required^
|group_name|Group of entities that will have their light enabled or disabled.|[[String]]|Yes|
|enabled|Determines the state of the lights (on or off).|[[Boolean]]|Yes|

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

====Example:====
<code lua>
set_group_light_enabled("torches", true)
</code>
//Results:// All entities in the "torches" group will have their lights enabled (i.e. they will be turned on and cast light).

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

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

<WRAP half column>
====Visual Demo:==== 
{{:wiki:set_group_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