User Tools

Site Tools


set_ambient_light_enabled

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
Last revisionBoth sides next revision
set_ambient_light_enabled [2017/08/13 07:25] justinset_ambient_light_enabled [2020/05/04 09:33] justin
Line 2: Line 2:
 ---- ----
  
-Enables or disables the map's [[ambient light]].+Enables or disables the [[map|map's]] [[ambient light]].
  
 +====Signature:====
 <code python> <code python>
 set_ambient_light_enabled(enabled) set_ambient_light_enabled(enabled)
Line 9: Line 10:
  
 ^Argument^Description^Type^Required^ ^Argument^Description^Type^Required^
-|enabled|Determines the [[ambient light]]'s state (on or off).|[[Boolean]]|Yes|+|enabled|Determines the [[ambient_light|ambient light's]] state (on or off).|[[Boolean]]|Yes|
  
 <WRAP center round info 100%> <WRAP center round info 100%>
-If you'd like to change the color of the ambient light instead of turning it on or off, see the related [[Set Ambient Light Color]] function.+If you'd like to change the [[color]] of the [[ambient light]] instead of turning it on or off, see the related [[Set Ambient Light Color]] function.
 </WRAP> </WRAP>
  
 ====Example:==== ====Example:====
-<code lua>+<code bauxite>
 set_ambient_light_enabled(false) set_ambient_light_enabled(false)
 </code> </code>
-//Results:// The map's [[ambient light]] is disabled and no longer affects the scene until enabled again.+//Results:// The [[map|map's]] [[ambient light]] is disabled and no longer affects the scene until enabled again.
  
 <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 another 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 32: Line 33:
  
 <WRAP half column> <WRAP half column>
-====Visual Demo:==== +====Visual Demo:====
 {{:wiki:set_ambient_light_enabled_demo.gif?nolink|}} {{:wiki:set_ambient_light_enabled_demo.gif?nolink|}}
 </WRAP> </WRAP>
set_ambient_light_enabled.txt · Last modified: 2021/04/21 18:49 by justin