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

Particle emitter instance. More...

Inheritance diagram for 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...
 
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 ()
 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)
 Set if the controlle is frozen. More...
 
void setControllerClamp (int controller, bool clamp)
 Set if the controller value is clamped or wrapped around if outside range. More...
 
void incrementController (int controller, float amount)
 Increments the controller value. More...
 
void setControllerToLower (int controller)
 Set controller value to lower value. More...
 
void setControllerToUpper (int controller)
 Set controller value to upper value. More...
 
bool isControllerAtLower (int controller)
 Controller value is at lower value. More...
 
bool isControllerAtUpper (int controller)
 Controller value is at upper value. More...
 

Detailed Description

Particle emitter instance.

This is a native class.

Author
Roland Pl├╝ss
Version
1.0
Date
2015

Member Function Documentation

§ getCollisionFilter()

CollisionFilter getCollisionFilter ( )

Collision filter.

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

§ getEmitter()

ParticleEmitter getEmitter ( )

Pparticle emitter or null if not set.

§ getEnableCasting()

bool getEnableCasting ( )

Casting particles is enabled.

§ getListener()

Listener or null if not set.

§ getOrientation()

Quaternion getOrientation ( )

Orientation.

§ getPosition()

DVector getPosition ( )

Position.

§ getRemoveAfterLastParticleDied()

bool getRemoveAfterLastParticleDied ( )

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

§ getTimeScale()

float getTimeScale ( )

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

§ getTypeComponent()

Component 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 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.

§ incrementController()

void incrementController ( int  controller,
float  amount 
)

Increments the controller value.

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

§ isControllerAtLower()

bool isControllerAtLower ( int  controller)

Controller value is at lower value.

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

§ isControllerAtUpper()

bool isControllerAtUpper ( int  controller)

Controller value is at upper value.

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

§ killAllParticles()

void killAllParticles ( )

Kill all particles.

§ new()

Create particle emitter instance.

§ resetBurst()

void resetBurst ( )

Reset burst.

§ setCollisionFilter()

void setCollisionFilter ( CollisionFilter  collisionFilter)

Set collision filter.

§ setControllerClamp()

void setControllerClamp ( int  controller,
bool  clamp 
)

Set if the controller value is clamped or wrapped around if outside range.

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

§ setControllerFrozen()

void setControllerFrozen ( int  controller,
bool  frozen 
)

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

§ setControllerToLower()

void setControllerToLower ( int  controller)

Set controller value to lower value.

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

§ setControllerToUpper()

void setControllerToUpper ( int  controller)

Set controller value to upper value.

Exceptions
EOutOfBoundarycontroller is less than 0 or large 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().

§ setEmitter()

void setEmitter ( ParticleEmitter  emitter)

Set particle emitter or null if not set.

§ setEnableCasting()

void setEnableCasting ( bool  enable)

Set if casting particles is enabled.

§ setListener()

void setListener ( ParticleEmitterInstanceListener  listener)

Set listener or null if not set.

§ setOrientation()

void setOrientation ( Quaternion  orientation)

Set orientation.

§ setPosition()

void setPosition ( DVector  position)

Set position.

§ setRemoveAfterLastParticleDied()

void setRemoveAfterLastParticleDied ( bool  remove)

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

§ setTimeScale()

void setTimeScale ( float  scale)

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

§ setTypeComponent()

void 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 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.

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