Particle effect API

Part of Mesh object (XOB)

Enums

Values

`ACTIVE_PARTICLES`	number of active particles. Int R
`AIR_RESISTANCE`	Float R/W
`AIR_RESISTANCE_RND`	Float R/W
`ANIM_ONCE`	Bool R/W
`AVELOCITY`	Float R/W
`BIRTH_RATE`	Float R/W
`BIRTH_RATE_RND`	Float R/W
`CONEANGLE`	Vector3 R/W
`CURRENT_TIME`	current efector's time. Float R/W
`EFFECT_TIME`	efector's total time. Float R/W
`EMITOFFSET`	Vector3 R/W
`GRAVITY_SCALE`	Float R/W
`GRAVITY_SCALE_RND`	Float R/W
`LIFETIME`	Float R/W
`LIFETIME_BY_ANIM`	Bool R/W
`LIFETIME_RND`	Float R/W
`RAND_FRAME`	Bool R/W
`RANDOM_ANGLE`	begin with random rotation. Bool R/W
`RANDOM_ROT`	rotate in random direction. Bool R/W
`REPEAT`	should efector repeate after time up? Bool R/W
`SIZE`	Float R/W
`SORT`	Bool R/W
`SPRING`	Float R/W
`STRETCH`	Float R/W
`VELOCITY`	Float R/W
`VELOCITY_RND`	Float R/W
`WIND`	Bool R/W

Functions

`proto native int GetParticleCount(notnull IEntity ent)`		more…
`proto int GetParticleEmitorCount(notnull IEntity ent)`		more…
`proto int GetParticleEmitors(notnull IEntity ent, out string emitors[], int max)`
`proto void GetParticleParm(notnull IEntity ent, int emitor, EmitorParam parameter, out void value)`		more…
`proto void GetParticleParmOriginal(notnull IEntity ent, int emitor, EmitorParam parameter, out void value)`		more…
`proto bool HasActiveParticle(notnull IEntity ent)`		more…
`int ParticleGetCount(IEntity ent)`		more…
`bool ParticleHasActive(IEntity ent)`		more…
`proto native void ResetParticlePosition(notnull IEntity ent)`
`proto native void RestartParticle(notnull IEntity ent)`
`proto void SetParticleParm(notnull IEntity ent, int emitor, EmitorParam parameter, void value)`		more…

Function Documentation

GetParticleCount

proto native int GetParticleCount(notnull IEntity ent)

Referenced by ParticleGetCount()

GetParticleEmitorCount

proto int GetParticleEmitorCount(notnull IEntity ent)

Referenced by Particle.GetMaxLifetime(), Particle.IncrementParticleParam(), Particle.IncrementParticleParamFromOriginal()

Show 7 more

, Particle.IsRepeat(), Particle.ScaleParticleParam(), Particle.ScaleParticleParamFromOriginal(), ParticleSource.IncrementParticleParam(), ParticleSource.IncrementParticleParamFromOriginal(), ParticleSource.ScaleParticleParam(), and ParticleSource.ScaleParticleParamFromOriginal()

GetParticleParm

proto void GetParticleParm(notnull IEntity ent, int emitor, EmitorParam parameter, out void value)

Referenced by Particle.GetMaxLifetime(), Particle.GetParameter(), Particle.GetParameterEx()

Show 7 more

, Particle.IncrementParticleParam(), Particle.IsRepeat(), Particle.ScaleParticleParam(), ParticleSource.GetParameter(), ParticleSource.GetParameterEx(), ParticleSource.IncrementParticleParam(), and ParticleSource.ScaleParticleParam()

GetParticleParmOriginal

proto void GetParticleParmOriginal(notnull IEntity ent, int emitor, EmitorParam parameter, out void value)

Referenced by Particle.GetParameterOriginal(), Particle.IncrementParticleParamFromOriginal(), Particle.ScaleParticleParamFromOriginal()

Show 2 more

, ParticleSource.IncrementParticleParamFromOriginal(), and ParticleSource.ScaleParticleParamFromOriginal()

HasActiveParticle

proto bool HasActiveParticle(notnull IEntity ent)

Referenced by ParticleHasActive()

ParticleGetCount

int ParticleGetCount(IEntity ent)

References GetParticleCount()

Referenced by Particle.GetParticleCount()

ParticleHasActive

bool ParticleHasActive(IEntity ent)

References HasActiveParticle()

Referenced by Particle.HasActiveParticle()

SetParticleParm

proto void SetParticleParm(notnull IEntity ent, int emitor, EmitorParam parameter, void value)

Referenced by Particle.IncrementParticleParam(), Particle.IncrementParticleParamFromOriginal(), Particle.ScaleParticleParam()

Show 9 more

, Particle.ScaleParticleParamFromOriginal(), Particle.SetParameter(), Particle.SetParticleParam(), ParticleSource.IncrementParticleParam(), ParticleSource.IncrementParticleParamFromOriginal(), ParticleSource.ScaleParticleParam(), ParticleSource.ScaleParticleParamFromOriginal(), ParticleSource.SetParameter(), and ParticleSource.SetParticleParam()