Particles

Particle system functions. Create a particle actor with CreateParticleActor() first.

Sub StartParticleEmitter(actor)

Starts particle emission for a particle actor

See also

StopParticleEmitter()


Sub StopParticleEmitter(actor)

Stops particle emission for a particle actor

See also

StartParticleEmitter()


Sub SetParticleDirection(actor, x, y, z)

Sets the direction of a particle emitter

See also

GetParticleDirection()


Sub GetParticleDirection(actor, ByRef x, ByRef y, ByRef z)

Gets the direction of a particle emitter

See also

SetParticleDirection()


Sub UseParticleEveryMeshVertex(actor, flag)

Sets whether to emit min max particles for every vertex or to pick min max vertices.


Function ParticleIsUsingEveryMeshVertex(actor)

Returns true if emitter emits min max particles for every vertex or to pick min max vertices.


Sub SetParticleNormalDirectionMod(actor, nd_mod)

Sets the normal direction modifier for a particle emitter Note: Only applies to mesh particle emitter

See also

GetParticleNormalDirectionMod()


Function GetParticleNormalDirectionMod(actor)

Returns the normal direction modifier for a particle emitter

Note: Only applies to mesh particle emitter

See also

SetParticleNormalDirectionMod()


Sub UseParticleNormalDirection(actor, flag)

Sets whether particle emitter is using vertex normal for direction, or direction specified.


Function ParticleIsUsingNormalDirection(actor)

Returns true if particle emitter is using vertex normal for direction, or direction specified.


Sub SetParticleMesh(actor, mesh)

Sets the mesh for a mesh particle emitter

Note: Only applies to mesh emitter


Function GetMinParticlesPerSecond(actor)

Returns the min number of particles emitted per second

See also

SetMinParticlesPerSecond(), GetMaxParticlesPerSecond(), SetMaxParticlesPerSecond()


Sub SetMinParticlesPerSecond(actor, minParticlesPerSecond)

Sets the min number of particles emitted per second

See also

SetMaxParticlesPerSecond(), GetMinParticlesPerSecond(), SetMaxParticlesPerSecond()


Sub SetMaxParticlesPerSecond(actor, maxParticlesPerSecond)

Sets the max number of particles emitted per second

See also

GetMaxParticlesPerSecond(), GetMinParticlesPerSecond(), SetMinParticlesPerSecond()


Function GetMaxParticlesPerSecond(actor)

Returns the max number of particles emitted per second

See also

SetMaxParticlesPerSecond(), GetMinParticlesPerSecond(), SetMinParticlesPerSecond()


Sub SetParticleMinStartColor(actor, color)

Sets the min start color for particles

See also

GetParticleMinStartColor()


Sub SetParticleMaxStartColor(actor, color)

Sets max starting color for particles

See also

SetParticleMaxStartColor()


Function GetParticleMaxStartColor(actor)

Returns max starting color for particles

See also

SetParticleMaxStartColor()


Function GetParticleMinStartColor(actor)

Returns the min start color for particles

See also

SetParticleMinStartColor()


setParticleMaxStartColor(actor, color)

Sets max starting color for particles

See also

SetParticleMaxStartColor()


Sub SetParticleMinLife(actor, minLife)

Set the min life of particles

Note: minLife is in milliseconds

See also

SetParticleMinLife()


Function GetParticleMinLife(actor)

Get the min life of particles

Note: Returned time is in milliseconds

See also

SetParticleMinLife()


Sub SetParticleMaxLife(actor, maxLife)

Sets the max life of the particle emission

Note: maxLife is in milliseconds

See also

GetParticleMaxLife()


Function GetParticleMaxLife(actor)

Returns the max life of the particle emission

Note: Returned time is in milliseconds

See also

SetParticleMaxLife()


Sub SetParticleMaxAngle(actor, maxAngle)

Sets the max angle of particle emission

See also

GetParticleMaxAngle()


Function GetParticleMaxAngle(actor)

Returns the max angle of particle emission

See also

SetParticleMaxAngle()


Sub SetParticleMinStartSize(actor, w, h)

Sets the min start size for particle emitter

See also

GetParticleMinStartSize()


Sub GetParticleMinStartSize(actor, ByRef w, ByRef h)

Gets the min start size for particle emitter

See also

SetParticleMinStartSize()


Sub SetParticleMaxStartSize(actor, w, h)

Sets the max start size for the particles

See also

SetParticleMaxStartSize()


Sub GetParticleMaxStartSize(actor, ByRef w, ByRef h)

Gets the max start size for the particles

See also

SetParticleMaxStartSize()


Sub SetParticleCenter(actor, x, y, z)

Sets the center of a particle emitter

Note: applies to Sphere, Cylinder, and Ring emitters

See also

GetParticleCenter()


Sub GetParticleCenter(actor, ByRef x, ByRef y, ByRef z)

Gets the center of a particle emitter Note: applies to Sphere, Cylinder, and Ring emitters

See also

SetParticleCenter()


Sub SetParticleRadius(actor, radius)

Sets the radius of a particle emitter

Note: Only applies to Sphere, Cylinder, and Ring emitters

See also

SetParticleRadius()


Function GetParticleRadius(actor)

Returns the radius of a particle emitter

Note: Only applies to Sphere, Cylinder, and Ring emitters

See also

SetParticleRadius()


Sub setParticleRingThickness(actor, ringThickness)

Sets the thickness of a ring emitter

Note: Only applies to ring emitter

See also

GetParticleRingThickness()


GFunction etParticleRingThickness(actor)

Returns the thickness of a ring emitter

Note: Only applies to ring emitter

See also

SetParticleRingThickness()


Sub SetParticleBox(actor, min_x, min_y, min_z, max_x, max_y, max_z)

Sets the bounding box for a particle emitter


Sub GetParticleBox(actor, ByRef min_x, ByRef min_y, ByRef min_z, ByRef max_x, ByRef max_y, ByRef max_z)

Gets the bounding box for a particle emitter


Sub SetParticleNormal(actor, x, y, z)

Sets the normal of a particle emitter

Note: Only applies to cylinder particle emitter

See also

GetParticleNormal()


Sub GetParticleNormal(actor, ByRef x, ByRef y, ByRef z)

Gets the normal of a particle emitter

Note: Only applies to cylinder particle emitter

See also

SetParticleNormal()


Sub SetParticleLength(actor, p_len)

Sets the length of a cylinder particle emitter

Note: Only applies to cylinder particles

See also

GetParticleLength()


Function GetParticleLength(actor)

Returns the length of a cylinder particle emitter

Note: Only applies to cylinder particles

See also

SetParticleLength()


Sub UseParticleOutlineOnly(actor, flag)

Set whether or not to draw points inside the cylinder.

Note: Only applies to cylinder emitter


Function ParticleIsUsingOutlineOnly(actor)

Returns true if not using draw points inside the cylinder.

Note: Only applies to cylinder emitter


Function GetParticleType(actor)

Returns the particle type.

Possible Particle Types:

  • PARTICLE_TYPE_POINT
  • PARTICLE_TYPE_BOX
  • PARTICLE_TYPE_SPHERE
  • PARTICLE_TYPE_CYLINDER
  • PARTICLE_TYPE_MESH
  • PARTICLE_TYPE_RING