User Tools

Site Tools


set_ambient_light_color

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
set_ambient_light_color [2017/08/12 09:06] justinset_ambient_light_color [2021/04/21 18:48] (current) 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> <code python>
 set_ambient_light_color(color, duration) set_ambient_light_color(color, duration)
Line 9: Line 10:
  
 ^Argument^Description^Type^Required^ ^Argument^Description^Type^Required^
-|color|New color for the [[ambient light]].|[[Color]]|Yes| +|color|New [[color]] for the [[ambient light]].|[[Color]]|Yes| 
-|duration|Fade duration from its current color to the new color.|[[Decimal]]|No|+|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:==== ====Example:====
-<code lua+<code bauxite
-set_ambient_light_color(color[255, 0, 255], 1)+set_ambient_light_color(color[255, 0, 255], 1);
 </code> </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|map's]] [[ambient light]] will change to magenta over a duration of one second.
  
 <WRAP center round tip 100%> <WRAP center round tip 100%>
-Use the **Set Ambient Light Color** function to change the overall mood of a room or to complement an entity light source's color change.+Use the **Set Ambient Light Color** function to change the overall mood of a room or to complement another light source'[[color]] change.
 </WRAP> </WRAP>
  
Line 29: Line 34:
  
 <WRAP half column> <WRAP half column>
-====Visual Demo:==== +====Visual Demo:====
 {{:wiki:set_ambient_light_color_demo.gif?nolink|}} {{:wiki:set_ambient_light_color_demo.gif?nolink|}}
 </WRAP> </WRAP>
set_ambient_light_color.1502554013.txt.gz · Last modified: 2017/08/12 09:06 by justin