User Tools

Site Tools


apply_lighting_preset

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
apply_lighting_preset [2021/12/13 15:23] justinapply_lighting_preset [2021/12/13 15:48] justin
Line 2: Line 2:
 ---- ----
  
-Changes...+Changes the lighting of the current [[map]] over a duration of time
  
 ====Signature:==== ====Signature:====
Line 10: Line 10:
  
 ^Argument^Description^Type^Required^ ^Argument^Description^Type^Required^
-|preset_name|[[groups|Group]] of [[entity|entities]] that will have their light [[color]] changed.|[[String]]|Yes| +|preset_name|Name of the lighting preset (as defined in the [[Map Editor]]).|[[String]]|Yes| 
-|duration|Fade duration from their current [[color]] to the new [[color]].|[[Number]]|No| +|duration|Fade duration from the current lighting to the new lighting.|[[Number]]|No|
- +
-<WRAP center round info 100%> +
-If you'd like to instantly toggle the [[entity]] [[groups|group's]] lights on or off instead of changing their [[color]], see the related [[Set Group Light Enabled]] function. +
-</WRAP>+
  
 ====Example:==== ====Example:====
Line 21: Line 17:
 apply_lighting_preset("Night", 2); apply_lighting_preset("Night", 2);
 </code> </code>
-//Results:// All [[entity|entities]] in the "torches[[groups|group]] will have the [[color]] of their light change to red over a duration of one second.+//Results:// The current [[map|map's]] lighting will change to the "Nightpreset over a duration of two seconds.
  
 <WRAP center round tip 100%> <WRAP center round tip 100%>
-Use the **Set Group Light Color** function to dim/brighten all lamps in a room or to emulate multi-color lights (like an LED on an electronic device).+Use the **Apply Lighting Preset** function to give the effect that the time of day has changed or to change the atmosphere of an indoor scene.
 </WRAP> </WRAP>
  
Line 30: Line 26:
 <WRAP half column> <WRAP half column>
 ====Editor Node:==== ====Editor Node:====
-{{:wiki:apply_lighting_preset_node.png?nolink|}}+{{:apply_lighting_preset_node.png?nolink|}}
 </WRAP> </WRAP>
  
 <WRAP half column> <WRAP half column>
 ====Visual Demo:==== ====Visual Demo:====
-{{:wiki:apply_lighting_preset_demo.gif?nolink|}} 
 </WRAP> </WRAP>
 </WRAP> </WRAP>
  
 ~~NOTOC~~ ~~NOTOC~~
apply_lighting_preset.txt · Last modified: 2021/12/13 16:04 by justin