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 Ambient Light Color======
----

Changes the [[color]] of the [[map|map's]] [[ambient light]] over a duration of time.

====Signature:====
<code python>
set_ambient_light_color(color, duration)
</code>

^Argument^Description^Type^Required^
|color|New [[color]] for the [[ambient light]].|[[Color]]|Yes|
|duration|Fade duration from its current [[color]] to the new [[color]].|[[Number]]|No|

<WRAP center round info 100%>
If you'd like to instantly toggle the [[ambient light]] on or off instead of changing its [[color]], see the related [[Set Ambient Light Enabled]] function.
</WRAP>

====Example:====
<code bauxite>
set_ambient_light_color(color[255, 0, 255], 1);
</code>
//Results:// The [[color]] of the [[map|map's]] [[ambient light]] will change to magenta over a duration of one second.

<WRAP center round tip 100%>
Use the **Set Ambient Light Color** function to change the overall mood of a room or to complement another light source's [[color]] change.
</WRAP>

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

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

~~NOTOC~~

RPG in a BoxOfficial Documentation

User Tools

Site Tools

Page Tools

RPG in a Box
Official Documentation