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

Particle emitter instance. More...

Inheritance diagram for Dragengine.Scenery.ParticleEmitterInstance:

Public Member Functions

Constructors
ParticleEmitterInstance new ()
 Create particle emitter instance. More...
 
Management
ParticleEmitter getEmitter ()
 Pparticle emitter or null if not set. More...
 
void setEmitter (ParticleEmitter emitter)
 Set particle emitter or null if not set. More...
 
DVector getPosition ()
 Position. More...
 
void setPosition (DVector position)
 Set position. More...
 
Quaternion getOrientation ()
 Orientation. More...
 
void setOrientation (Quaternion orientation)
 Set orientation. More...
 
bool getEnableCasting ()
 Casting particles is enabled. More...
 
void setEnableCasting (bool enable)
 Set if casting particles is enabled. More...
 
bool getRemoveAfterLastParticleDied ()
 Emitter instance is removed from the world if the last particle died. More...
 
void setRemoveAfterLastParticleDied (bool remove)
 Set if the emitter instance is removed from the world if the last particle died. More...
 
float getTimeScale ()
 Scaling for the time to be added to controllers linked to time. More...
 
void setTimeScale (float scale)
 Set scaling for the time to be added to controllers linked to time. More...
 
float getWarmUpTime ()
 Warm up time used when enabling casting. More...
 
void setWarmUpTime (float warmUpTime)
 Set warm up time used when enabling casting. More...
 
float getBurstTime ()
 Burst time. Set by the physics module to be used by the graphics module. More...
 
void setBurstTime (float burstTime)
 Set burst time. Set by the physics module to be used by the graphics module. More...
 
LayerMask getLayerMask ()
 Rendr layer mask. More...
 
void setLayerMask (LayerMask layerMask)
 Set render layer mask. More...
 
CollisionFilter getCollisionFilter ()
 Collision filter. More...
 
void setCollisionFilter (CollisionFilter collisionFilter)
 Set collision filter. More...
 
void resetBurst ()
 Reset burst. More...
 
void killAllParticles ()
 Kill all particles. More...
 
ParticleEmitterInstanceListener getListener ()
 Listener or null if not set. More...
 
void setListener (ParticleEmitterInstanceListener listener)
 Set listener or null if not set. More...
 
Types
Component getTypeComponent (int type)
 Component for type used for casting or null. More...
 
void setTypeComponent (int type, Component component)
 Set component for type used for casting or null. More...
 
DynamicSkin getTypeDynamicSkin (int type)
 Dynamic skin for type or null if not used. More...
 
void setTypeDynamicSkin (int type, DynamicSkin dynamicSkin)
 Set dynamic skin for type or null if not used. More...
 
Controllers
int getControllerCount ()
 Nnumber 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...
 
void copyControllerStates (ParticleEmitterInstance instance, int count)
 Copy the first count controller values and vectors from another particle emitter instance. More...
 
void copyControllerStates (ParticleEmitterInstance instance, int offset, int count)
 Copy the first count controller values and vectors from another particle emitter instance. More...
 
void copyNamedControllerStates (ParticleEmitterInstance instance)
 Copy name matching controller values and vectors from another particle emitter instance. More...
 
Ignore colliders
int getIgnoreColliderCount ()
 Number of colliders to ignore. More...
 
Collider getIgnoreColliderAt (int index)
 Ignore collider at index. More...
 
bool hasIgnoreCollider (Collider collider)
 Ignore collider is present. More...
 
void addIgnoreCollider (Collider collider)
 Add collider to ignore. More...
 
void removeIgnoreCollider (Collider collider)
 Remove collider to ignore. More...
 
void removeAllIgnoreColliders ()
 Remove all colliders to ignore. More...
 

Detailed Description

Particle emitter instance.

This is a native class.

Member Function Documentation

◆ addIgnoreCollider()

void Dragengine.Scenery.ParticleEmitterInstance.addIgnoreCollider ( Collider  collider)

Add collider to ignore.

Version
1.7

◆ copyControllerStates() [1/2]

void Dragengine.Scenery.ParticleEmitterInstance.copyControllerStates ( ParticleEmitterInstance  instance,
int  count 
)

Copy the first count controller values and vectors from another particle emitter instance.

Bones outside the number of controllers are ignored.

Exceptions
EInvalidParamcount is less than 0.

◆ copyControllerStates() [2/2]

void Dragengine.Scenery.ParticleEmitterInstance.copyControllerStates ( ParticleEmitterInstance  instance,
int  offset,
int  count 
)

Copy the first count controller values and vectors from another particle emitter instance.

Offset index of controller to copy from other particle emitter. Bones outside the number of controllers are ignored.

Exceptions
EInvalidParamcount is less than 0.

◆ copyNamedControllerStates()

void Dragengine.Scenery.ParticleEmitterInstance.copyNamedControllerStates ( ParticleEmitterInstance  instance)

Copy name matching controller values and vectors from another particle emitter instance.

Non-matching controllers are ignored.

◆ getBurstTime()

float Dragengine.Scenery.ParticleEmitterInstance.getBurstTime ( )

Burst time. Set by the physics module to be used by the graphics module.

Version
1.7

◆ getCollisionFilter()

CollisionFilter Dragengine.Scenery.ParticleEmitterInstance.getCollisionFilter ( )

Collision filter.

◆ getControllerAt()

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

Get wrapper for controller.

Warning
The wrapper is only valid as long as the particle emitter is not changed and the controller structure in the particle emitter instance 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.ParticleEmitterInstance.getControllerCount ( )

Nnumber of controllers.

◆ getControllerNamed()

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

Get wrapper for controller if present.

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

◆ getEmitter()

ParticleEmitter Dragengine.Scenery.ParticleEmitterInstance.getEmitter ( )

Pparticle emitter or null if not set.

◆ getEnableCasting()

bool Dragengine.Scenery.ParticleEmitterInstance.getEnableCasting ( )

Casting particles is enabled.

◆ getIgnoreColliderAt()

Collider Dragengine.Scenery.ParticleEmitterInstance.getIgnoreColliderAt ( int  index)

Ignore collider at index.

Version
1.7
Exceptions
deeInvalidParamindex is less than 0 or equal than or equal to getIgnoreColliderCount().

◆ getIgnoreColliderCount()

int Dragengine.Scenery.ParticleEmitterInstance.getIgnoreColliderCount ( )

Number of colliders to ignore.

Version
1.7

◆ getLayerMask()

LayerMask Dragengine.Scenery.ParticleEmitterInstance.getLayerMask ( )

Rendr layer mask.

◆ getListener()

ParticleEmitterInstanceListener Dragengine.Scenery.ParticleEmitterInstance.getListener ( )

Listener or null if not set.

◆ getOrientation()

Quaternion Dragengine.Scenery.ParticleEmitterInstance.getOrientation ( )

Orientation.

◆ getPosition()

DVector Dragengine.Scenery.ParticleEmitterInstance.getPosition ( )

Position.

◆ getRemoveAfterLastParticleDied()

bool Dragengine.Scenery.ParticleEmitterInstance.getRemoveAfterLastParticleDied ( )

Emitter instance is removed from the world if the last particle died.

◆ getTimeScale()

float Dragengine.Scenery.ParticleEmitterInstance.getTimeScale ( )

Scaling for the time to be added to controllers linked to time.

◆ getTypeComponent()

Component Dragengine.Scenery.ParticleEmitterInstance.getTypeComponent ( int  type)

Component for type used for casting or null.

Exceptions
EOutOfBoundarytype is less than 0 or larger than or equal to emitter instance type count.

◆ getTypeDynamicSkin()

DynamicSkin Dragengine.Scenery.ParticleEmitterInstance.getTypeDynamicSkin ( int  type)

Dynamic skin for type or null if not used.

Exceptions
EOutOfBoundarytype is less than 0 or larger than or equal to emitter instance type count.

◆ getWarmUpTime()

float Dragengine.Scenery.ParticleEmitterInstance.getWarmUpTime ( )

Warm up time used when enabling casting.

Version
1.7

◆ hasIgnoreCollider()

bool Dragengine.Scenery.ParticleEmitterInstance.hasIgnoreCollider ( Collider  collider)

Ignore collider is present.

Version
1.7

◆ indexOfControllerNamed()

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

Index of named controller or -1 if not found.

◆ killAllParticles()

void Dragengine.Scenery.ParticleEmitterInstance.killAllParticles ( )

Kill all particles.

◆ new()

ParticleEmitterInstance Dragengine.Scenery.ParticleEmitterInstance.new ( )

Create particle emitter instance.

◆ removeAllIgnoreColliders()

void Dragengine.Scenery.ParticleEmitterInstance.removeAllIgnoreColliders ( )

Remove all colliders to ignore.

Version
1.7

◆ removeIgnoreCollider()

void Dragengine.Scenery.ParticleEmitterInstance.removeIgnoreCollider ( Collider  collider)

Remove collider to ignore.

Version
1.7
Exceptions
deeInvalidParamcollider is absent.

◆ resetBurst()

void Dragengine.Scenery.ParticleEmitterInstance.resetBurst ( )

Reset burst.

◆ setBurstTime()

void Dragengine.Scenery.ParticleEmitterInstance.setBurstTime ( float  burstTime)

Set burst time. Set by the physics module to be used by the graphics module.

Version
1.7

◆ setCollisionFilter()

void Dragengine.Scenery.ParticleEmitterInstance.setCollisionFilter ( CollisionFilter  collisionFilter)

Set collision filter.

◆ setEmitter()

void Dragengine.Scenery.ParticleEmitterInstance.setEmitter ( ParticleEmitter  emitter)

Set particle emitter or null if not set.

Warning
Replaces collision filter with the on in emitter.

◆ setEnableCasting()

void Dragengine.Scenery.ParticleEmitterInstance.setEnableCasting ( bool  enable)

Set if casting particles is enabled.

◆ setLayerMask()

void Dragengine.Scenery.ParticleEmitterInstance.setLayerMask ( LayerMask  layerMask)

Set render layer mask.

◆ setListener()

void Dragengine.Scenery.ParticleEmitterInstance.setListener ( ParticleEmitterInstanceListener  listener)

Set listener or null if not set.

◆ setOrientation()

void Dragengine.Scenery.ParticleEmitterInstance.setOrientation ( Quaternion  orientation)

Set orientation.

◆ setPosition()

void Dragengine.Scenery.ParticleEmitterInstance.setPosition ( DVector  position)

Set position.

◆ setRemoveAfterLastParticleDied()

void Dragengine.Scenery.ParticleEmitterInstance.setRemoveAfterLastParticleDied ( bool  remove)

Set if the emitter instance is removed from the world if the last particle died.

◆ setTimeScale()

void Dragengine.Scenery.ParticleEmitterInstance.setTimeScale ( float  scale)

Set scaling for the time to be added to controllers linked to time.

◆ setTypeComponent()

void Dragengine.Scenery.ParticleEmitterInstance.setTypeComponent ( int  type,
Component  component 
)

Set component for type used for casting or null.

Exceptions
EOutOfBoundarytype is less than 0 or larger than or equal to emitter instance type count.

◆ setTypeDynamicSkin()

void Dragengine.Scenery.ParticleEmitterInstance.setTypeDynamicSkin ( int  type,
DynamicSkin  dynamicSkin 
)

Set dynamic skin for type or null if not used.

Exceptions
EOutOfBoundarytype is less than 0 or larger than or equal to emitter instance type count.

◆ setWarmUpTime()

void Dragengine.Scenery.ParticleEmitterInstance.setWarmUpTime ( float  warmUpTime)

Set warm up time used when enabling casting.

Version
1.7

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