VfxFloatAnimatedWithRandomDriver

Inheritance 2 ancestors · 24 siblings

Class Documentation

A float driver that returns an animated value with random variation: the embedded ValueFloat in Float, sampled at a time source. ValueFloat is the constantValue plus optional dynamics curve that the complex emitters use, see Animated values on VfxEmitterDefinitionData.

On every evaluation:

If Float has no dynamics, the driver returns constantValue.
The driver reads the time source frequency.
If looping is set and the time is past the end of the curve, the time wraps: the driver takes the remainder of the time divided by the length of the curve.
The driver samples the curve at that time. If the curve has probability tables, the tables scale the result as they do on a complex emitter.

The curve's times are positions on the time source: seconds for the sources 1, 3 and 7, fractions for the others.

Random numbers. The probability tables read their random numbers from random slots. So the numbers are per particle (drawn at spawn) or per emitter, as the property that holds the value decides, see Random values on IVfxBaseDriver. The vector and colour variants (VfxVector2AnimatedWithRandomDriver, VfxVector3AnimatedWithRandomDriver, VfxColorRgbAnimatedWithRandomDriver, VfxColorAnimatedWithRandomDriver) also have ShareRandom. When it is set, all components read one random number. When it is not set, each component reads its own.

Over a physics step, the driver samples the curve at both ends of the step when it is the top node of the value, see Interval evaluation on IVfxBaseDriver.

Properties

Float

Embed<ValueFloat> = { "constantValue": 0, "dynamics": null }

15.23

Documentation Edit documentation

The curve, a ValueFloat. If it has no dynamics, the driver returns its constantValue.

frequency

U8 = 0

Documentation Edit documentation

The time source. The Time sources table on IVfxBaseDriver lists the values.

graph

Embed<ValueFloat> = { "constantValue": 0, "dynamics": null }

Removed in 15.23

Documentation Add documentation

No documentation available yet. Click "Add documentation" to contribute!

looping

Bool = false

15.23

Documentation Edit documentation

When true, a time past the end of the curve wraps back to its start, so the curve repeats. When false, the curve holds its last key.