Composable particle emitter for element class. More...

Inheritance diagram for Dragengine.Scenery.ECComposeParticleEmitter:

Public Member Functions
ParticleEmitterInstance	createParticleEmitterInstance (Element element, StubElement stub)
	Create particle emitter instance for element from stub.

TSTriggerExpression	createTriggerCasting (Element element, StubElement stub)
	Create casting trigger expression from stub or null if not used.

TSTriggerExpression	createTriggerCasting (Element element, StubElement stub, String defaultValue)
	Create casting trigger expression from stub or null if not used.

ECPBoolean	getCasting ()
	Emitter is casting particles.

ECComposeCollisionFilter	getCollisionFilter ()
	Collision filter.

LayerMask	getLayerMask ()
	Layer mask to set (basic layer mask).

ECPParticleEmitter	getParticleEmitter ()
	Particle emitter resource.

String	getPrefix ()
	Property prefix.

ECPFloat	getTimeScale ()
	Time scale for controllers advanced by time.

ECPFloat	getWarmUpTime ()
	Warm up time when start casting.

ECComposeParticleEmitter	new (ElementClass ownerClass, Loaders loaders)
	Create composable element class.

ECComposeParticleEmitter	new (ElementClass ownerClass, Loaders loaders, String prefix)
	Create composable element class.

void	setLayerMask (LayerMask layerMask)
	Set layer mask to set (basic layer mask).

Detailed Description

Composable particle emitter for element class.

Provides particle emitter support to element class without subclassing from a specific class. Sets the particle emitter to use by particle emitter instance.

Member Function Documentation

◆ createParticleEmitterInstance()

ParticleEmitterInstance Dragengine.Scenery.ECComposeParticleEmitter.createParticleEmitterInstance	(	Element	element,
		StubElement	stub
	)

Create particle emitter instance for element from stub.

Creates particle emitter instance and assigns particle emitter. The particle emitter is not setEnableCasting() by default otherwise a burst of particles can be emitted although the trigger created later on evaluates to false.

◆ createTriggerCasting() [1/2]

TSTriggerExpression Dragengine.Scenery.ECComposeParticleEmitter.createTriggerCasting	(	Element	element,
		StubElement	stub
	)

Create casting trigger expression from stub or null if not used.

◆ createTriggerCasting() [2/2]

TSTriggerExpression Dragengine.Scenery.ECComposeParticleEmitter.createTriggerCasting	(	Element	element,
		StubElement	stub,
		String	defaultValue
	)

Create casting trigger expression from stub or null if not used.

◆ getCasting()

ECPBoolean Dragengine.Scenery.ECComposeParticleEmitter.getCasting ( )

Emitter is casting particles.

◆ getCollisionFilter()

ECComposeCollisionFilter Dragengine.Scenery.ECComposeParticleEmitter.getCollisionFilter ( )

Collision filter.

◆ getLayerMask()

LayerMask Dragengine.Scenery.ECComposeParticleEmitter.getLayerMask ( )

Layer mask to set (basic layer mask).

◆ getParticleEmitter()

ECPParticleEmitter Dragengine.Scenery.ECComposeParticleEmitter.getParticleEmitter ( )

Particle emitter resource.

◆ getPrefix()

String Dragengine.Scenery.ECComposeParticleEmitter.getPrefix ( )

Property prefix.

◆ getTimeScale()

ECPFloat Dragengine.Scenery.ECComposeParticleEmitter.getTimeScale ( )

Time scale for controllers advanced by time.

◆ getWarmUpTime()

ECPFloat Dragengine.Scenery.ECComposeParticleEmitter.getWarmUpTime ( )

Warm up time when start casting.

◆ new() [1/2]

ECComposeParticleEmitter Dragengine.Scenery.ECComposeParticleEmitter.new	(	ElementClass	ownerClass,
		Loaders	loaders
	)

Create composable element class.

Adds all properties to ownerClass. If you do not want a property to be configurable using XML subclassing use ownerClass.removeProperty() to remove them.

◆ new() [2/2]

ECComposeParticleEmitter Dragengine.Scenery.ECComposeParticleEmitter.new	(	ElementClass	ownerClass,
		Loaders	loaders,
		String	prefix
	)