Skip to content

Commit 2caf890

Browse files
author
Red Eclipse
committed
Build docs:4 from 06fd5a0214980bef1e91ef1b22f0ee007b968ab3
1 parent ec11692 commit 2caf890

File tree

1 file changed

+18
-11
lines changed

1 file changed

+18
-11
lines changed

docs/editing/Fx.md

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -111,16 +111,6 @@ Effects can be scheduled in various ways. To change how timing functions on an e
111111
* `emitmove` - as opposed to rest being `integer` type, this one is `float`, when set above `0`, only allows emission when emitter moves at a given speed. Default: `0`.
112112
* `emitparam` - only allows emission when internal emitter parameter (see *"Internal parameters"*) of a given index (`integer`) becomes larger than 0. Default: `-1`.
113113

114-
## Iteration
115-
116-
Effect emissions can also be repeated by iterating an effect. It allows you to create repeated patterns using a single effect instance.
117-
118-
* `iter` - how many times an effect should be emitted. Default: `1`.
119-
* `iteroffset` - position vector offset between each emission. Default: `0, 0, 0`.
120-
121-
You can also modulate various properties by interpolating the values by the iteration. (*see "Property modifiers"*)
122-
123-
124114
### Example 1: single-shot emission for 1 second
125115

126116
registerfx FX_EXAMPLE1 $FX_TYPE_PARTICLE [
@@ -160,6 +150,24 @@ Various properties can also have modifiers applied such as interpolation or rand
160150
**NOTE: In the supplied example a minimum interval of `2` is used, to ensure the emission is treated as periodic. Remember, value of `1` implies standard emission!**
161151
Emission will occur randomly from 2 to 1000 milliseconds (the random value is added to the base value).
162152

153+
## Iteration
154+
155+
Effect emissions can also be repeated by iterating an effect. It allows you to create repeated patterns using a single effect instance.
156+
157+
* `iter` - how many times an effect should be emitted. Default: `1`.
158+
* `iteroffset` - position vector offset between each emission. Default: `0, 0, 0`.
159+
160+
You can also modulate various properties by interpolating the values by the iteration. (*see "Property modifiers"*)
161+
162+
### Example: single particle repeated 5 times, increasing in size from 0.5 to 1.0, forming a cone
163+
164+
registerfx FX_EXAMPLE_ITER $FX_TYPE_PARTICLE [
165+
fxpropi iter 5
166+
fxpropfv iteroffset 0 0 10
167+
fxpropf partsize 0.5
168+
fxpropf partsize 1.0 $FX_MOD_LERP_ITER
169+
]
170+
163171
## Positioning
164172

165173
By default effects will be emitted from the origin position the attached entity and in its direction.
@@ -250,7 +258,6 @@ Interpolation (lerp) modifier has the following properties (all are `integer` ty
250258
| Internal parameter | 2 | $FX_MOD_LERP_PARAM | Interpolation by using parameter set by `lerpparam` as the factor. |
251259
| Iteration | 3 | $FX_MOD_LERP_ITER | Interpolation by using the iteration progress as the factor. (*see "Iteration"*) |
252260

253-
254261
### Interpolation shapes
255262

256263
| Shape | Value | CubeScript handle | Formula |

0 commit comments

Comments
 (0)