Pixel-Composer/scripts/BBMOD_SetRealModule/bbmod_setrealmodule.gml
2023-04-23 16:47:33 +02:00

31 lines
999 B
Text

/// @func BBMOD_SetRealModule([_property[, _value]])
///
/// @extends BBMOD_ParticleModule
///
/// @desc A universal particle module that sets initial value of particles'
/// property when they are spawned.
///
/// @param {Real} [_property] The property to set initial value of. Use values
/// from {@link BBMOD_EParticle}. Defaults to `undefined`.
/// @param {Real} [_value] The initial value of the property. Defaults to 0.0.
///
/// @see BBMOD_EParticle
function BBMOD_SetRealModule(_property=undefined, _value=0.0)
: BBMOD_ParticleModule() constructor
{
BBMOD_CLASS_GENERATED_BODY;
/// @var {Real} The property to set initial value of. Use values from
/// {@link BBMOD_EParticle}. Default value is `undefined`.
Property = _property;
/// @var {Real} The initial value of the property. Defaults to 0.0.
Value = _value;
static on_particle_start = function (_emitter, _particleIndex) {
if (Property != undefined)
{
_emitter.Particles[# Property, _particleIndex] = Value;
}
};
}