Drag[en]gine Script Module DragonScript  1.23
Dragengine.Scenery.ParticleEmitter Class Reference

Particle emitter. More...

Inheritance diagram for Dragengine.Scenery.ParticleEmitter:

Public Member Functions

Constructors
ParticleEmitter new ()
 Create particle emitter. More...
 
Controllers
int getControllerCount ()
 Nnumber of controllers. More...
 
void setControllerCount (int count)
 Set number of controllers. More...
 
ParticleEmitterController getControllerAt (int index)
 Get wrapper for controller. More...
 
ParticleEmitterController getControllerNamed (String name)
 Get wrapper for controller if present. More...
 
int indexOfControllerNamed (String name)
 Index of named controller or -1 if not found. More...
 
Burst
float getBurstLifetime ()
 Burst lifetime. More...
 
void setBurstLifetime (float lifetime)
 Set the burst liftime. More...
 
bool getEmitBurst ()
 Particles are emitted in bursts instead of continuous. More...
 
void setEmitBurst (bool emitBurst)
 Set if particles are emitted in bursts instead of continuous. More...
 
Types
int getTypeCount ()
 Number of types. More...
 
void setTypeCount (int count)
 Set number of types. More...
 
Skin getTypeSkin (int type)
 Type skin or null. More...
 
void setTypeSkin (int type, Skin skin)
 Set type skin or null. More...
 
Model getTypeModel (int type)
 Type model or null. More...
 
void setTypeModel (int type, Model model)
 Set type model or null. More...
 
Skin getTypeModelSkin (int type)
 Skin for the model used for casting or null. More...
 
void setTypeModelSkin (int type, Skin skin)
 Set skin for the model used for casting or null. More...
 
ParticleEmitterCastFrom getTypeCastFrom (int type)
 Determines from what part of the model to cast particles from. More...
 
void setTypeCastFrom (int type, ParticleEmitterCastFrom castFrom)
 Sets from what part of the model to cast particles from. More...
 
ParticleEmitterSimulation getTypeSimulationType (int type)
 Simulation type. More...
 
void setTypeSimulationType (int type, ParticleEmitterSimulation simulationType)
 Set simulation type. More...
 
bool getTypeIntervalAsDistance (int type)
 Interval is used as distance instead of time. More...
 
void setTypeIntervalAsDistance (int type, bool intervalAsDistance)
 Set if interval is used as distance instead of time. More...
 
ParticleEmitter getTypeTrailEmitter (int type)
 Particle emitter to create instances from for trails behind particles or null to use no trail. More...
 
void setTypeTrailEmitter (int type, ParticleEmitter emitter)
 Set particle emitter to create instances from for trails behind particles or null to use no trail. More...
 
int getTypeTrailController (int type, ParticleEmitterEmitController controller)
 Trail controller index or -1 if not set. More...
 
void setTypeTrailController (int type, ParticleEmitterEmitController controller, int targetController)
 Set trail controller index or -1 if not set. More...
 
float getTypePhysicsSize (int type)
 Physics size of the particle. More...
 
void setTypePhysicsSize (int type, float size)
 Set physics size of the particle. More...
 
ParticleCollisionResponse getTypeCollisionResponse (int type)
 Collision response. More...
 
void setTypeCollisionResponse (int type, ParticleCollisionResponse response)
 Set collision response. More...
 
ParticleEmitter getTypeCollisionEmitter (int type)
 Particle emitter to create instances from for colliding particles or null to spawn no instances. More...
 
void setTypeCollisionEmitter (int type, ParticleEmitter emitter)
 Set particle emitter to create instances from for colliding particles or null to spawn no instances. More...
 
float getTypeEmitMinImpulse (int type)
 minimum impulse required for colliding particles to emit instances. More...
 
void setTypeEmitMinImpulse (int type, float impulse)
 Set minimum impulse required for colliding particles to emit instances. More...
 
int getTypeEmitController (int type, ParticleEmitterEmitController controller)
 Emit controller index or -1 if not set. More...
 
void setTypeEmitController (int type, ParticleEmitterEmitController controller, int targetController)
 Set emit controller index or -1 if not set. More...
 
Type parameters
void setTypeParameterValue (int type, ParticleEmitterParameter parameter, float value)
 Set parameter value. More...
 
void setTypeParameterSpread (int type, ParticleEmitterParameter parameter, float spread)
 Set parameter spread. More...
 
void setTypeParameterControllerValue (int type, ParticleEmitterParameter parameter, int controller)
 Set parameter value curve controller. More...
 
void setTypeParameterCurveValue (int type, ParticleEmitterParameter parameter, CurveBezier curve)
 Set parameter value curve or null if not used. More...
 
void setTypeParameterControllerSpread (int type, ParticleEmitterParameter parameter, int controller)
 Set parameter spread curve controller. More...
 
void setTypeParameterCurveSpread (int type, ParticleEmitterParameter parameter, CurveBezier curve)
 Set parameter spread curve or null if not used. More...
 
void setTypeParameterCurveProgress (int type, ParticleEmitterParameter parameter, CurveBezier curve)
 Set parameter progress curve or null if not used. More...
 
void setTypeParameterCurveBeam (int type, ParticleEmitterParameter parameter, CurveBezier curve)
 Set parameter beam curve or null if not used. More...
 

Detailed Description

Particle emitter.

This is a native class.

Member Function Documentation

◆ getBurstLifetime()

float Dragengine.Scenery.ParticleEmitter.getBurstLifetime ( )

Burst lifetime.

◆ getControllerAt()

ParticleEmitterController Dragengine.Scenery.ParticleEmitter.getControllerAt ( int  index)

Get wrapper for controller.

Warning
The wrapper is only valid as long as the controller structure in the particle emitter is not changed.
Parameters
indexIndex of controller. If index is negative controller count is added to it. This allows to get controllers starting from the last controller.
Exceptions
EOutOfBoundarycontroller is less than -getControllerCount() or larger than or equal to getControllerCount().

◆ getControllerCount()

int Dragengine.Scenery.ParticleEmitter.getControllerCount ( )

Nnumber of controllers.

◆ getControllerNamed()

ParticleEmitterController Dragengine.Scenery.ParticleEmitter.getControllerNamed ( String  name)

Get wrapper for controller if present.

Warning
The wrapper is only valid as long as the controller structure in the particle emitter is not changed.
Parameters
nameName of controller. If no controller with this name is present null is returned.

◆ getEmitBurst()

bool Dragengine.Scenery.ParticleEmitter.getEmitBurst ( )

Particles are emitted in bursts instead of continuous.

◆ getTypeCastFrom()

ParticleEmitterCastFrom Dragengine.Scenery.ParticleEmitter.getTypeCastFrom ( int  type)

Determines from what part of the model to cast particles from.

Exceptions
EOutOfBoundarytype is less than 0 or larger than or equal to getTypeCount().

◆ getTypeCollisionEmitter()

ParticleEmitter Dragengine.Scenery.ParticleEmitter.getTypeCollisionEmitter ( int  type)

Particle emitter to create instances from for colliding particles or null to spawn no instances.

Exceptions
EOutOfBoundarytype is less than 0 or larger than or equal to getTypeCount().

◆ getTypeCollisionResponse()

ParticleCollisionResponse Dragengine.Scenery.ParticleEmitter.getTypeCollisionResponse ( int  type)

Collision response.

Exceptions
EOutOfBoundarytype is less than 0 or larger than or equal to getTypeCount().

◆ getTypeCount()

int Dragengine.Scenery.ParticleEmitter.getTypeCount ( )

Number of types.

◆ getTypeEmitController()

int Dragengine.Scenery.ParticleEmitter.getTypeEmitController ( int  type,
ParticleEmitterEmitController  controller 
)

Emit controller index or -1 if not set.

Exceptions
EOutOfBoundarytype is less than 0 or larger than or equal to getTypeCount().

◆ getTypeEmitMinImpulse()

float Dragengine.Scenery.ParticleEmitter.getTypeEmitMinImpulse ( int  type)

minimum impulse required for colliding particles to emit instances.

Exceptions
EOutOfBoundarytype is less than 0 or larger than or equal to getTypeCount().

◆ getTypeIntervalAsDistance()

bool Dragengine.Scenery.ParticleEmitter.getTypeIntervalAsDistance ( int  type)

Interval is used as distance instead of time.

Exceptions
EOutOfBoundarytype is less than 0 or larger than or equal to getTypeCount().

◆ getTypeModel()

Model Dragengine.Scenery.ParticleEmitter.getTypeModel ( int  type)

Type model or null.

Exceptions
EOutOfBoundarytype is less than 0 or larger than or equal to getTypeCount().

◆ getTypeModelSkin()

Skin Dragengine.Scenery.ParticleEmitter.getTypeModelSkin ( int  type)

Skin for the model used for casting or null.

Exceptions
EOutOfBoundarytype is less than 0 or larger than or equal to getTypeCount().

◆ getTypePhysicsSize()

float Dragengine.Scenery.ParticleEmitter.getTypePhysicsSize ( int  type)

Physics size of the particle.

Exceptions
EOutOfBoundarytype is less than 0 or larger than or equal to getTypeCount().

◆ getTypeSimulationType()

ParticleEmitterSimulation Dragengine.Scenery.ParticleEmitter.getTypeSimulationType ( int  type)

Simulation type.

Exceptions
EOutOfBoundarytype is less than 0 or larger than or equal to getTypeCount().

◆ getTypeSkin()

Skin Dragengine.Scenery.ParticleEmitter.getTypeSkin ( int  type)

Type skin or null.

Exceptions
EOutOfBoundarytype is less than 0 or larger than or equal to getTypeCount().

◆ getTypeTrailController()

int Dragengine.Scenery.ParticleEmitter.getTypeTrailController ( int  type,
ParticleEmitterEmitController  controller 
)

Trail controller index or -1 if not set.

Exceptions
EOutOfBoundarytype is less than 0 or larger than or equal to getTypeCount().

◆ getTypeTrailEmitter()

ParticleEmitter Dragengine.Scenery.ParticleEmitter.getTypeTrailEmitter ( int  type)

Particle emitter to create instances from for trails behind particles or null to use no trail.

Exceptions
EOutOfBoundarytype is less than 0 or larger than or equal to getTypeCount().

◆ indexOfControllerNamed()

int Dragengine.Scenery.ParticleEmitter.indexOfControllerNamed ( String  name)

Index of named controller or -1 if not found.

◆ new()

ParticleEmitter Dragengine.Scenery.ParticleEmitter.new ( )

Create particle emitter.

◆ setBurstLifetime()

void Dragengine.Scenery.ParticleEmitter.setBurstLifetime ( float  lifetime)

Set the burst liftime.

◆ setControllerCount()

void Dragengine.Scenery.ParticleEmitter.setControllerCount ( int  count)

Set number of controllers.

Exceptions
EInvalidParamcount is less than 0.

◆ setEmitBurst()

void Dragengine.Scenery.ParticleEmitter.setEmitBurst ( bool  emitBurst)

Set if particles are emitted in bursts instead of continuous.

◆ setTypeCastFrom()

void Dragengine.Scenery.ParticleEmitter.setTypeCastFrom ( int  type,
ParticleEmitterCastFrom  castFrom 
)

Sets from what part of the model to cast particles from.

Exceptions
EOutOfBoundarytype is less than 0 or larger than or equal to getTypeCount().

◆ setTypeCollisionEmitter()

void Dragengine.Scenery.ParticleEmitter.setTypeCollisionEmitter ( int  type,
ParticleEmitter  emitter 
)

Set particle emitter to create instances from for colliding particles or null to spawn no instances.

Exceptions
EOutOfBoundarytype is less than 0 or larger than or equal to getTypeCount().

◆ setTypeCollisionResponse()

void Dragengine.Scenery.ParticleEmitter.setTypeCollisionResponse ( int  type,
ParticleCollisionResponse  response 
)

Set collision response.

Exceptions
EOutOfBoundarytype is less than 0 or larger than or equal to getTypeCount().

◆ setTypeCount()

void Dragengine.Scenery.ParticleEmitter.setTypeCount ( int  count)

Set number of types.

◆ setTypeEmitController()

void Dragengine.Scenery.ParticleEmitter.setTypeEmitController ( int  type,
ParticleEmitterEmitController  controller,
int  targetController 
)

Set emit controller index or -1 if not set.

Exceptions
EOutOfBoundarytype is less than 0 or larger than or equal to getTypeCount().

◆ setTypeEmitMinImpulse()

void Dragengine.Scenery.ParticleEmitter.setTypeEmitMinImpulse ( int  type,
float  impulse 
)

Set minimum impulse required for colliding particles to emit instances.

Exceptions
EOutOfBoundarytype is less than 0 or larger than or equal to getTypeCount().

◆ setTypeIntervalAsDistance()

void Dragengine.Scenery.ParticleEmitter.setTypeIntervalAsDistance ( int  type,
bool  intervalAsDistance 
)

Set if interval is used as distance instead of time.

Exceptions
EOutOfBoundarytype is less than 0 or larger than or equal to getTypeCount().

◆ setTypeModel()

void Dragengine.Scenery.ParticleEmitter.setTypeModel ( int  type,
Model  model 
)

Set type model or null.

Exceptions
EOutOfBoundarytype is less than 0 or larger than or equal to getTypeCount().

◆ setTypeModelSkin()

void Dragengine.Scenery.ParticleEmitter.setTypeModelSkin ( int  type,
Skin  skin 
)

Set skin for the model used for casting or null.

Exceptions
EOutOfBoundarytype is less than 0 or larger than or equal to getTypeCount().

◆ setTypeParameterControllerSpread()

void Dragengine.Scenery.ParticleEmitter.setTypeParameterControllerSpread ( int  type,
ParticleEmitterParameter  parameter,
int  controller 
)

Set parameter spread curve controller.

Exceptions
EOutOfBoundarytype is less than 0 or larger than or equal to getTypeCount().
EInvalidParamparameter is not a valid value.

◆ setTypeParameterControllerValue()

void Dragengine.Scenery.ParticleEmitter.setTypeParameterControllerValue ( int  type,
ParticleEmitterParameter  parameter,
int  controller 
)

Set parameter value curve controller.

Exceptions
EOutOfBoundarytype is less than 0 or larger than or equal to getTypeCount().
EInvalidParamparameter is not a valid value.

◆ setTypeParameterCurveBeam()

void Dragengine.Scenery.ParticleEmitter.setTypeParameterCurveBeam ( int  type,
ParticleEmitterParameter  parameter,
CurveBezier  curve 
)

Set parameter beam curve or null if not used.

Exceptions
EOutOfBoundarytype is less than 0 or larger than or equal to getTypeCount().
EInvalidParamparameter is not a valid value.

◆ setTypeParameterCurveProgress()

void Dragengine.Scenery.ParticleEmitter.setTypeParameterCurveProgress ( int  type,
ParticleEmitterParameter  parameter,
CurveBezier  curve 
)

Set parameter progress curve or null if not used.

Exceptions
EOutOfBoundarytype is less than 0 or larger than or equal to getTypeCount().
EInvalidParamparameter is not a valid value.

◆ setTypeParameterCurveSpread()

void Dragengine.Scenery.ParticleEmitter.setTypeParameterCurveSpread ( int  type,
ParticleEmitterParameter  parameter,
CurveBezier  curve 
)

Set parameter spread curve or null if not used.

Exceptions
EOutOfBoundarytype is less than 0 or larger than or equal to getTypeCount().
EInvalidParamparameter is not a valid value.

◆ setTypeParameterCurveValue()

void Dragengine.Scenery.ParticleEmitter.setTypeParameterCurveValue ( int  type,
ParticleEmitterParameter  parameter,
CurveBezier  curve 
)

Set parameter value curve or null if not used.

Exceptions
EOutOfBoundarytype is less than 0 or larger than or equal to getTypeCount().
EInvalidParamparameter is not a valid value.

◆ setTypeParameterSpread()

void Dragengine.Scenery.ParticleEmitter.setTypeParameterSpread ( int  type,
ParticleEmitterParameter  parameter,
float  spread 
)

Set parameter spread.

Exceptions
EOutOfBoundarytype is less than 0 or larger than or equal to getTypeCount().
EInvalidParamparameter is not a valid value.

◆ setTypeParameterValue()

void Dragengine.Scenery.ParticleEmitter.setTypeParameterValue ( int  type,
ParticleEmitterParameter  parameter,
float  value 
)

Set parameter value.

Exceptions
EOutOfBoundarytype is less than 0 or larger than or equal to getTypeCount().
EInvalidParamparameter is not a valid value.

◆ setTypePhysicsSize()

void Dragengine.Scenery.ParticleEmitter.setTypePhysicsSize ( int  type,
float  size 
)

Set physics size of the particle.

Exceptions
EOutOfBoundarytype is less than 0 or larger than or equal to getTypeCount().

◆ setTypeSimulationType()

void Dragengine.Scenery.ParticleEmitter.setTypeSimulationType ( int  type,
ParticleEmitterSimulation  simulationType 
)

Set simulation type.

Exceptions
EOutOfBoundarytype is less than 0 or larger than or equal to getTypeCount().

◆ setTypeSkin()

void Dragengine.Scenery.ParticleEmitter.setTypeSkin ( int  type,
Skin  skin 
)

Set type skin or null.

Exceptions
EOutOfBoundarytype is less than 0 or larger than or equal to getTypeCount().

◆ setTypeTrailController()

void Dragengine.Scenery.ParticleEmitter.setTypeTrailController ( int  type,
ParticleEmitterEmitController  controller,
int  targetController 
)

Set trail controller index or -1 if not set.

Exceptions
EOutOfBoundarytype is less than 0 or larger than or equal to getTypeCount().

◆ setTypeTrailEmitter()

void Dragengine.Scenery.ParticleEmitter.setTypeTrailEmitter ( int  type,
ParticleEmitter  emitter 
)

Set particle emitter to create instances from for trails behind particles or null to use no trail.

Exceptions
EOutOfBoundarytype is less than 0 or larger than or equal to getTypeCount().

The documentation for this class was generated from the following file: