Emitter Object

Emitter

Description

This Particle Object emits particles. At least one of these is required to create a functional particle system. If multiple emitters are placed in the same particle system, they will all render in the same batch, and are therefore cheaper than the same number of emitters in separate particle systems.

Location

Right-click on an empty space in the Particle Creator Scene Manager and choose Emitter > Emitter from the list.

Properties

Name	Type	Description	Read Only
BOX EMITTER
DEPTH	float	Set the depth of the box.
HEIGHT	float	Set the height of the box.
WIDTH	float	Set the width of the box.
CIRCLE EMITTER
FIXED	bool	If True the circle emitter will have a fixed radius. ( Uses the "Max Radius" value ).
MAX RADIUS	float	The maximum radius of the emitter when using a sphere or circle.
MIN RADIUS	float	The minimum radius of the emitter when using a sphere or circle.
STEP	float	Set the particle step around the specified angle.
DIMENSIONS
DEPTH	float	The render depth of of the particle.
FIXED	bool	Set the fixed sized for particle. ( Uses the "Width" value ).
HEIGHT	float	Set the height of the particle.
SCALE ON LAUNCH	float	After the particle has its width and height it will be scaled.
WIDTH	float	Set the width of the particle.
EMISSION
CHANCE TO EMIT	float	The chance to emit per loop.
DELAY	float	Specify the amount of delay ( in seconds ) before starting over after the "Emit Duration" value has been reached.
DELAY FIRST	bool	If True the delay occurs first.
EMIT DURATION	float	Specify the duration ( in seconds ) for the emitter to release its particles. Note: If a dynamic property such as a range is used it will base the duration off the parent particle system.
EMIT RATE	float	Set the rate at which the particles being emitted are released. This is based off the "Emit Duration" value.
HIDE ON STOP	bool	If True the particles will be hidden when stopped. Note: This only works in game.
NUM LOOPS	int	Specify the number of loops. -1 loops forever.
PARTICLE LIFE	float	Specify the lifespan ( in seconds ) of a particle once it is released. Note: If a dynamic property is used it will use the "Emit Duration" value.
RELEASE OVER DISTANCE	bool	If True the emitter will release over the distance of 1 unit.
LINE EMITTER
END POSITION	CVector3	Specify the end position of the line.
MAX DEVIATION	float	Set the maximum deviation allowed on the line.
MAX INCREMENT	float	Set the maximum increment of the particles to release in.
MIN INCREMENT	float	Set the minimum increment of the particles to release in.
MOVEMENT
ANGLE	float	The angle at which to release the particles around the "Direction".
DIRECTION	CVector3	Set the direction the particles will be released in.
VELOCITY	float	Set the velocity of the emitter.
POSITION
POSITION	CVector3	Position by X,Y,Z world coordinates.
PROPERTIES
ENABLED	bool	Set the Emitter object enabled or not.
GROUND OFFSET	float	The offset from ground.
KEEP LOCAL	bool	If True the particles will stay local to the Emitter.
MASS	float	Set the mass of the particles.
MUST SPAWN ON GROUND	bool	If True the particle must spawn on the ground.
NO EXPIRATION	bool	If True particles don't expire.
ORIENT TO GROUND	bool	If True particles orient to the ground normal. Only used when "Spawn on Ground" is True.
SPAWN ON GROUND	bool	If True particles spawn on the ground.
SPHERE EMITTER
RADIUS	float	Set the radius of the emitter when using a sphere or circle.
TYPE
TYPE OF EMITTER	string	Specify the type of emitter: Box Circle Line Point SphereSurface

Input Events

Enable

Enable the Emitter object.

Disable

Disable the Emitter object.

Output Events

None