Differences

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

--- set_ambient_light_color [2017/08/12 08:37] – created justin
+++ set_ambient_light_color [2020/04/22 17:53] – justin
@@ Line 2: / Line 2: @@
 ----
-Changes the color of the map's [[ambient light]] over a duration of time.
+Changes the [[color]] of the [[map|map's]] [[ambient light]] over a duration of time.
+====Signature:====
 <code python>
 set_ambient_light_color(color, duration)
@@ Line 11: / Line 12: @@
 |color|New color for the [[ambient light]].|[[Color]]|Yes|
 |duration|Fade duration from its current color to the new color.|[[Decimal]]|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 lua>
+<code bauxite>
 set_ambient_light_color(color[255, 0, 255], 1)
 </code>
-//Results:// The color of the map's [[ambient light]] will change to purple over a duration of one second.
+//Results:// The color of the 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
+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>
@@ Line 29: / Line 34: @@
 <WRAP half column>
 ====Visual Demo:====
 {{:wiki:set_ambient_light_color_demo.gif?nolink|}}
 </WRAP>

RPG in a BoxOfficial Documentation