RPG in a Box
Official Documentation

User Tools

Site Tools

Trace:
set_group_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
Next revisionBoth sides next revision
set_group_light_color [2017/09/26 12:14] – justinset_group_light_color [2020/04/27 11:59] – justin
Line 2: Line 2:
 ---- ----
  
-Changes the color of the light attached to any entities in the specified group over a duration of time (with the assumption that each entity is a light source).+Changes the color of the light attached to any [[entity|entities]] in the specified [[groups|group]] over a duration of time (with the assumption that each [[entity]] is a light source).
  
 +====Signature:====
 <code python> <code python>
 set_group_light_color(group_name, color, duration) set_group_light_color(group_name, color, duration)
Line 9: Line 10:
  
 ^Argument^Description^Type^Required^ ^Argument^Description^Type^Required^
-|group_name|Group of entities that will have their light color changed.|[[String]]|Yes| +|group_name|[[groups|Group]] of [[entity|entities]] that will have their light [[color]] changed.|[[String]]|Yes| 
-|color|New color for the lights.|[[Color]]|Yes| +|color|New [[color]] for the lights.|[[Color]]|Yes| 
-|duration|Fade duration from their current color to the new color.|[[Decimal]]|No|+|duration|Fade duration from their current [[color]] to the new [[color]].|[[Number]]|No|
  
 <WRAP center round info 100%> <WRAP center round info 100%>
-If you'd like to instantly toggle the entity group's lights on or off instead of changing their color, see the related [[Set Group Light Enabled]] function.+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> </WRAP>
  
 ====Example:==== ====Example:====
-<code lua>+<code bauxite>
 set_group_light_color("torches", color[255, 0, 0], 1) set_group_light_color("torches", color[255, 0, 0], 1)
 </code> </code>
-//Results:// All entities in the "torches" group will have the color of their light change to red over a duration of one second.+//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.
  
 <WRAP center round tip 100%> <WRAP center round tip 100%>
set_group_light_color.txt · Last modified: 2021/04/21 18:51 by justin

Page Tools

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki