Drag[en]gine Script Module DragonScript Script API  1.0
ParticleEmitter Class Reference

Particle emitter. More...

Inheritance diagram for ParticleEmitter:

Public Member Functions

Constructors
ParticleEmitter new ()
 Create particle emitter. More...
 
Management
CollisionFilter getCollisionFilter ()
 Collision filter. More...
 
void setCollisionFilter (CollisionFilter collisionFilter)
 Set collision filter. More...
 
Controllers
int getControllerCount ()
 Number of controllers. More...
 
void setControllerCount (int count)
 Set number of controllers. More...
 
float getControllerLower (int controller)
 Lower limit of controller. More...
 
float getControllerUpper (int controller)
 Upper limit of controller. More...
 
void setControllerRange (int controller, float lower, float upper)
 Set controller value range. More...
 
float getControllerValue (int controller)
 Value of controller. More...
 
void setControllerValue (int controller, float value)
 Set controller value. More...
 
void setControllerFrozen (int controller, bool frozen)
 Sets if the controlle is frozen. More...
 
void setControllerClamp (int controller, bool clamp)
 Sets if controller value is clamped or wrapped around if outside range. More...
 
void incrementController (int controller, float amount)
 Increments controller value. 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...
 
int getTypeCastFrom (int type)
 Determines from what part of the model to cast particles from. More...
 
void setTypeCastFrom (int type, int castFrom)
 Sets from what part of the model to cast particles from. More...
 
int getTypeSimulationType (int type)
 Simulation type. More...
 
void setTypeSimulationType (int type, int 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, int controller)
 Trail controller index or -1 if not set. More...
 
void setTypeTrailController (int type, int 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...
 
int getCollisionResponse (int type)
 Collision response. More...
 
void setCollisionResponse (int type, int 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, int controller)
 Emit controller index or -1 if not set. More...
 
void setTypeEmitController (int type, int controller, int targetController)
 Set emit controller index or -1 if not set. More...
 
Type parameters
void setTypeParameterValue (int type, int parameter, float value)
 Set parameter value. More...
 
void setTypeParameterSpread (int type, int parameter, float spread)
 Set parameter spread. More...
 
void setTypeParameterControllerValue (int type, int parameter, int controller)
 Set parameter value curve controller. More...
 
void setTypeParameterCurveValue (int type, int parameter, CurveBezier curve)
 Set parameter value curve or null if not used. More...
 
void setTypeParameterControllerSpread (int type, int parameter, int controller)
 Set parameter spread curve controller. More...
 
void setTypeParameterCurveSpread (int type, int parameter, CurveBezier curve)
 Set parameter spread curve or null if not used. More...
 
void setTypeParameterCurveProgress (int type, int parameter, CurveBezier curve)
 Set parameter progress curve or null if not used. More...
 
void setTypeParameterCurveBeam (int type, int parameter, CurveBezier curve)
 Set parameter beam curve or null if not used. More...
 

Static Public Attributes

Parameter constants
static final int PARAM_TIME_TO_LIVE = 0
 Time to life. More...
 
static final int PARAM_INTERVAL = 1
 Cast interval. More...
 
static final int PARAM_PARTICLE_COUNT = 2
 Particle count per burst or per beam. More...
 
static final int PARAM_CAST_ANGLE_X = 3
 Cast angle in x direction. More...
 
static final int PARAM_CAST_ANGLE_Y = 4
 Cast angle in y direction. More...
 
static final int PARAM_SIZE = 5
 Particle size. More...
 
static final int PARAM_RED = 6
 Red intensity. More...
 
static final int PARAM_GREEN = 7
 Green intensity. More...
 
static final int PARAM_BLUE = 8
 Blue intensity. More...
 
static final int PARAM_TRANSPARENCY = 9
 Transparency. More...
 
static final int PARAM_EMISSIVITY = 10
 Emissivity. More...
 
static final int PARAM_MASS = 11
 Particle mass. More...
 
static final int PARAM_ROTATION = 12
 Particle rotation relative to camer plane. More...
 
static final int PARAM_LINEAR_VELOCITY = 13
 Linear velocity magnitude. More...
 
static final int PARAM_ANGULAR_VELOCITY = 14
 Angular velocity magnitude. More...
 
static final int PARAM_BROWN = 15
 Brown motion. More...
 
static final int PARAM_DAMP = 16
 Damping. More...
 
static final int PARAM_DRAG = 17
 Drag resistence. More...
 
static final int PARAM_GRAVITY_X = 18
 Gravity in x direction. More...
 
static final int PARAM_GRAVITY_Y = 19
 Gravity in y direction. More...
 
static final int PARAM_GRAVITY_Z = 20
 Gravity in z direction. More...
 
static final int PARAM_LOCAL_GRAVITY = 21
 Use local gravity. More...
 
static final int PARAM_FORCE_FIELD_DIRECT = 22
 Force field factor for direct force fields. More...
 
static final int PARAM_FORCE_FIELD_SURFACE = 23
 Force field factor for surface force fields. More...
 
static final int PARAM_FORCE_FIELD_MASS = 24
 Force field factor for mass force fields. More...
 
static final int PARAM_FORCE_FIELD_SPEED = 25
 Force field factor for speed force fields. More...
 
static final int PARAM_ELASTICITY = 26
 Elasticity during collisions. More...
 
static final int PARAM_ROUGHNESS = 27
 Roughness during collisions. More...
 
static final int PARAM_EMIT_DIRECTION = 28
 Collision emit direction. More...
 
Controller constants
static final int CONTROLLER_LIFETIME = 0
 Particle lifetime. More...
 
static final int CONTROLLER_MASS = 1
 Particle mass. More...
 
static final int CONTROLLER_LINEAR_VELOCITY = 2
 Linear velocity magnitude. More...
 
static final int CONTROLLER_ANGULAR_VELOCITY = 3
 Angular velocity magnitude. More...
 
Cast source constants
static final int CAST_FROM_VERTEX = 0
 Cast from vertices. More...
 
static final int CAST_FROM_FACE = 1
 Cast from faces. More...
 
static final int CAST_FROM_VOLUME = 2
 Cash from volume. More...
 
Collision response constants
static final int RESPONSE_DESTROY = 0
 Destroy particle on collision. More...
 
static final int RESPONSE_PHYSICAL = 1
 Physicsl collision response. More...
 
static final int RESPONSE_CUSTOM = 2
 Custom collision response. More...
 
Simulation type constants
static final int SIMULATION_PARTICLE = 0
 Particles. More...
 
static final int SIMULATION_RIBBON = 1
 Ribbon. More...
 
static final int SIMULATION_BEAM = 2
 Beam. More...
 

Detailed Description

Particle emitter.

This is a native class.

Author
Roland Pl├╝ss
Version
1.0
Date
2015

Member Function Documentation

§ getBurstLifetime()

float getBurstLifetime ( )

Burst lifetime.

§ getCollisionFilter()

CollisionFilter getCollisionFilter ( )

Collision filter.

§ getCollisionResponse()

int getCollisionResponse ( int  type)

Collision response.

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

§ getControllerCount()

int getControllerCount ( )

Number of controllers.

§ getControllerLower()

float getControllerLower ( int  controller)

Lower limit of controller.

Exceptions
EOutOfBoundarycontroller is less than 0 or larger than or equal to getControllerCount().

§ getControllerUpper()

float getControllerUpper ( int  controller)

Upper limit of controller.

Exceptions
EOutOfBoundarycontroller is less than 0 or larger than or equal to getControllerCount().

§ getControllerValue()

float getControllerValue ( int  controller)

Value of controller.

Exceptions
EOutOfBoundarycontroller is less than 0 or larger than or equal to getControllerCount().

§ getEmitBurst()

bool getEmitBurst ( )

Particles are emitted in bursts instead of continuous.

§ getTypeCastFrom()

int 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 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().

§ getTypeCount()

int getTypeCount ( )

Number of types.

§ getTypeEmitController()

int getTypeEmitController ( int  type,
int  controller 
)

Emit controller index or -1 if not set.

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

§ getTypeEmitMinImpulse()

float 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 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 getTypeModel ( int  type)

Type model or null.

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

§ getTypeModelSkin()

Skin 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 getTypePhysicsSize ( int  type)

Physics size of the particle.

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

§ getTypeSimulationType()

int getTypeSimulationType ( int  type)

Simulation type.

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

§ getTypeSkin()

Skin getTypeSkin ( int  type)

Type skin or null.

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

§ getTypeTrailController()

int getTypeTrailController ( int  type,
int  controller 
)

Trail controller index or -1 if not set.

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

§ getTypeTrailEmitter()

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().

§ incrementController()

void incrementController ( int  controller,
float  amount 
)

Increments controller value.

Exceptions
EOutOfBoundarycontroller is less than 0 or larger than or equal to getControllerCount().

§ new()

ParticleEmitter new ( )

Create particle emitter.

§ setBurstLifetime()

void setBurstLifetime ( float  lifetime)

Set the burst liftime.

§ setCollisionFilter()

void setCollisionFilter ( CollisionFilter  collisionFilter)

Set collision filter.

§ setCollisionResponse()

void setCollisionResponse ( int  type,
int  response 
)

Set collision response.

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

§ setControllerClamp()

void setControllerClamp ( int  controller,
bool  clamp 
)

Sets if controller value is clamped or wrapped around if outside range.

Exceptions
EOutOfBoundarycontroller is less than 0 or larger than or equal to getControllerCount().

§ setControllerCount()

void setControllerCount ( int  count)

Set number of controllers.

§ setControllerFrozen()

void setControllerFrozen ( int  controller,
bool  frozen 
)

Sets if the controlle is frozen.

Exceptions
EOutOfBoundarycontroller is less than 0 or larger than or equal to getControllerCount().

§ setControllerRange()

void setControllerRange ( int  controller,
float  lower,
float  upper 
)

Set controller value range.

Exceptions
EOutOfBoundarycontroller is less than 0 or larger than or equal to getControllerCount().

§ setControllerValue()

void setControllerValue ( int  controller,
float  value 
)

Set controller value.

Exceptions
EOutOfBoundarycontroller is less than 0 or larger than or equal to getControllerCount().

§ setEmitBurst()

void setEmitBurst ( bool  emitBurst)

Set if particles are emitted in bursts instead of continuous.

§ setTypeCastFrom()

void setTypeCastFrom ( int  type,
int  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 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().

§ setTypeCount()

void setTypeCount ( int  count)

Set number of types.

§ setTypeEmitController()

void setTypeEmitController ( int  type,
int  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 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 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 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 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 setTypeParameterControllerSpread ( int  type,
int  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 setTypeParameterControllerValue ( int  type,
int  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 setTypeParameterCurveBeam ( int  type,
int  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 setTypeParameterCurveProgress ( int  type,
int  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 setTypeParameterCurveSpread ( int  type,
int  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 setTypeParameterCurveValue ( int  type,
int  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 setTypeParameterSpread ( int  type,
int  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 setTypeParameterValue ( int  type,
int  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 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 setTypeSimulationType ( int  type,
int  simulationType 
)

Set simulation type.

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

§ setTypeSkin()

void 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 setTypeTrailController ( int  type,
int  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 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().

Member Data Documentation

§ CAST_FROM_FACE

final int CAST_FROM_FACE = 1
static

Cast from faces.

§ CAST_FROM_VERTEX

final int CAST_FROM_VERTEX = 0
static

Cast from vertices.

§ CAST_FROM_VOLUME

final int CAST_FROM_VOLUME = 2
static

Cash from volume.

§ CONTROLLER_ANGULAR_VELOCITY

final int CONTROLLER_ANGULAR_VELOCITY = 3
static

Angular velocity magnitude.

§ CONTROLLER_LIFETIME

final int CONTROLLER_LIFETIME = 0
static

Particle lifetime.

§ CONTROLLER_LINEAR_VELOCITY

final int CONTROLLER_LINEAR_VELOCITY = 2
static

Linear velocity magnitude.

§ CONTROLLER_MASS

final int CONTROLLER_MASS = 1
static

Particle mass.

§ PARAM_ANGULAR_VELOCITY

final int PARAM_ANGULAR_VELOCITY = 14
static

Angular velocity magnitude.

§ PARAM_BLUE

final int PARAM_BLUE = 8
static

Blue intensity.

§ PARAM_BROWN

final int PARAM_BROWN = 15
static

Brown motion.

§ PARAM_CAST_ANGLE_X

final int PARAM_CAST_ANGLE_X = 3
static

Cast angle in x direction.

§ PARAM_CAST_ANGLE_Y

final int PARAM_CAST_ANGLE_Y = 4
static

Cast angle in y direction.

§ PARAM_DAMP

final int PARAM_DAMP = 16
static

Damping.

§ PARAM_DRAG

final int PARAM_DRAG = 17
static

Drag resistence.

§ PARAM_ELASTICITY

final int PARAM_ELASTICITY = 26
static

Elasticity during collisions.

§ PARAM_EMISSIVITY

final int PARAM_EMISSIVITY = 10
static

Emissivity.

§ PARAM_EMIT_DIRECTION

final int PARAM_EMIT_DIRECTION = 28
static

Collision emit direction.

§ PARAM_FORCE_FIELD_DIRECT

final int PARAM_FORCE_FIELD_DIRECT = 22
static

Force field factor for direct force fields.

§ PARAM_FORCE_FIELD_MASS

final int PARAM_FORCE_FIELD_MASS = 24
static

Force field factor for mass force fields.

§ PARAM_FORCE_FIELD_SPEED

final int PARAM_FORCE_FIELD_SPEED = 25
static

Force field factor for speed force fields.

§ PARAM_FORCE_FIELD_SURFACE

final int PARAM_FORCE_FIELD_SURFACE = 23
static

Force field factor for surface force fields.

§ PARAM_GRAVITY_X

final int PARAM_GRAVITY_X = 18
static

Gravity in x direction.

§ PARAM_GRAVITY_Y

final int PARAM_GRAVITY_Y = 19
static

Gravity in y direction.

§ PARAM_GRAVITY_Z

final int PARAM_GRAVITY_Z = 20
static

Gravity in z direction.

§ PARAM_GREEN

final int PARAM_GREEN = 7
static

Green intensity.

§ PARAM_INTERVAL

final int PARAM_INTERVAL = 1
static

Cast interval.

§ PARAM_LINEAR_VELOCITY

final int PARAM_LINEAR_VELOCITY = 13
static

Linear velocity magnitude.

§ PARAM_LOCAL_GRAVITY

final int PARAM_LOCAL_GRAVITY = 21
static

Use local gravity.

§ PARAM_MASS

final int PARAM_MASS = 11
static

Particle mass.

§ PARAM_PARTICLE_COUNT

final int PARAM_PARTICLE_COUNT = 2
static

Particle count per burst or per beam.

§ PARAM_RED

final int PARAM_RED = 6
static

Red intensity.

§ PARAM_ROTATION

final int PARAM_ROTATION = 12
static

Particle rotation relative to camer plane.

§ PARAM_ROUGHNESS

final int PARAM_ROUGHNESS = 27
static

Roughness during collisions.

§ PARAM_SIZE

final int PARAM_SIZE = 5
static

Particle size.

§ PARAM_TIME_TO_LIVE

final int PARAM_TIME_TO_LIVE = 0
static

Time to life.

§ PARAM_TRANSPARENCY

final int PARAM_TRANSPARENCY = 9
static

Transparency.

§ RESPONSE_CUSTOM

final int RESPONSE_CUSTOM = 2
static

Custom collision response.

§ RESPONSE_DESTROY

final int RESPONSE_DESTROY = 0
static

Destroy particle on collision.

§ RESPONSE_PHYSICAL

final int RESPONSE_PHYSICAL = 1
static

Physicsl collision response.

§ SIMULATION_BEAM

final int SIMULATION_BEAM = 2
static

Beam.

§ SIMULATION_PARTICLE

final int SIMULATION_PARTICLE = 0
static

Particles.

§ SIMULATION_RIBBON

final int SIMULATION_RIBBON = 1
static

Ribbon.


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