User Tools

Site Tools


4rpl:commands:createmist

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
4rpl:commands:createmist [2021/05/24 17:02] – Changed "birthTime" and "fadeTime" to "birthtime" and "fadetime" to match the sample code Argonwolf4rpl:commands:createmist [2024/02/03 18:05] (current) – Fixed strange note wording and provided advanced example plus copy and paste preset. Vertu
Line 1: Line 1:
 ~~NOTOC~~ ~~NOTOC~~
-<=[[4rpl:start| Index]]+<=[[4rpl:start| Index]]\\ 
 +<= [[4rpl:start#Effects]]
  
 ====== CreateMist ====== ====== CreateMist ======
Line 17: Line 18:
  
 Each value in the color and color2 vectors is a floating point number where 1 is full brightness and 0 is minimal brightness. Values over 1 make the mist glow. Each value in the color and color2 vectors is a floating point number where 1 is full brightness and 0 is minimal brightness. Values over 1 make the mist glow.
 +
 +:NOTE: There is a hidden hard cap for the amount of mist that can exist. When reached, no additional mist will be created.\\
 +Avoid calling this API every frame to avoid reaching this cap. Every 5 frames is far more reasonable.
 ===== Examples ===== ===== Examples =====
 <code 4rpl> <code 4rpl>
Line 29: Line 33:
 endif endif
 CreateMist(V3(10 1 10 ) <-initData) CreateMist(V3(10 1 10 ) <-initData)
 +</code>
 +
 +<code 4rpl>
 +once
 +   Table("color" V3(1 1 1)
 +         "birthtime" 0
 +         "fadetime" 20
 +         "direction" V3(0 1 0)
 +         "startradius" 0
 +         "endradius" 10 ) ->initData
 +   do(50 0)
 +      CreateMist(V3(10 1 10 ) <-initData)
 +   loop
 +endonce
 +
 +#This creates a ring-shaped burst of mist particles near the bottom-left corner of the map
 +#Since "direction" represents a vertical axis (in this case "up"), the ring will expand horizontally around said axis
 +#By swapping the "startradius" and "endradius" values, the ring will instead collapse inward
 +</code>
 +
 +<code 4rpl>
 +if(GetUnitUpdateCount 5 % eq0) #Ensure we don't make uneccessary mist.
 + CreateMist(GetUnitPosition(self) <-initData)
 +endif
 +
 +:Once
 + Table("color" V3(1 0.8 0.8)
 +    "color2" V3(0.2 0 0)
 +    "birthtime" 40
 +    "fadetime" 20
 +    "direction" V3(1 5 1.5)
 +    "startradius" 0.5
 +    "endradius" 1) ->initData
 +</code>
 +
 +==== Copy and paste preset: ====
 +<code 4rpl>
 +Table("color" V3(1 0.8 0.8)
 +    "color2" V3(0.2 0 0)
 +    "birthtime" 40
 +    "fadetime" 20
 +    "direction" V3(1 5 1.5)
 +    "startradius" 0.5
 +    "endradius" 1) ->initData
 </code> </code>
 <=[[4rpl:start| Index]] <=[[4rpl:start| Index]]
  
4rpl/commands/createmist.1621890124.txt.gz · Last modified: 2021/05/24 17:02 by Argonwolf