BBMOD_AttractorModule

A constructor defined in BBMOD_AttractorModule.gml

Extends BBMOD_ParticleModule

new BBMOD_AttractorModule([_position[, _relative[, _radius[, _force]]]])

Description

A particle module that attracts/repels particles to/from a given position.

Arguments

Name Type Description
_position Struct.BBMOD_Vec3 The position to attract/repel particles to/from. Defaults to (0, 0, 0).
_relative Bool If true, then the position is relative to the emitter. Defaults to true.
_radius Real The radius of the influence. Defaults to 1.0.
_force Real The strength of the force. Use negative to repel the particles. Defaults to 1.0.

Properties

Name Description
Force The strength of the force. Use negative to repel the particles. Defaults value is 1.0.
Position The position to attract/repel particles to/from. Default value is (0, 0, 0).
Radius The radius of the influence. Defaults to 1.0.
Relative If true, then BBMOD_AttractorModule.Position is relative to the emitter. Default value is true.

Inherited properties

Name Description
Enabled If true then the module is enabled. Defaults value is true.

Inherited methods

Name Description
on_finish Executed once at the end of the emitter's emission cycle. Never executed if the emitted particle system is looping!
on_particle_finish Executed when a particle dies.
on_particle_start Executed when a new particle is spawned.
on_start Executed at the beginning of the emitter's emission cycle and every time it loops.
on_update Executed every time the emitter is updated.
Do you find this page helpful?

Copyright © 2024, BlueBurn. Built on April 18, 2024 using GMDoc.