Dragengine.Scenery.ECPParticleEmitter Class Reference

Particle emitter element class property for use with XML loading. More...

Inheritance diagram for Dragengine.Scenery.ECPParticleEmitter:

Public Member Functions
void	copyValue (ElementClass elementClass, ElementClassProperty property)
	Copy value from another element class property of the same type.
bool	getHasPreloaded ()
	Property has been preloaded.
LoadParticleEmitter	getLoader ()
	Particle emitter loader.
ParticleEmitter	getParticleEmitter ()
	ParticleEmitter or null if not present.
String	getPath ()
	Path to particle emitter.
bool	logPreloadProblems (ElementClass elementClass, Console console)
	Log preloading problems.
ECPParticleEmitter	new (String name, LoadParticleEmitter loader)
	Create property.
ECPParticleEmitter	new (String name, LoadParticleEmitter loader, String path)
	Create property with initial path.
void	preloadResources (ElementClass elementClass, PreloadCounter counter)
	Preload resources if supported.
void	setParticleEmitter (ParticleEmitter particleEmitter)
	Set particle emitter or null if not present.
void	setPath (String path)
	Set path to particle emitter.
void	setValue (Object value)
	Set value of property from XML decoded value.
Public Member Functions inherited from Dragengine.Scenery.ElementClassProperty
void	dispose ()
	Dispose of element class property to break reference loops.
String	getName ()
	Name.
ElementClassProperty	new (String name)
	Create property.

Public Attributes
Exception	pException
bool	pHasPreloaded
LoadParticleEmitter	pLoader
ParticleEmitter	pParticleEmitter
String	pPath

Detailed Description

Particle emitter element class property for use with XML loading.

Particle emitter is set from XML using a path. Loads the particle emitter during preloading. The value of the property is then the loaded resource. If loading fails null particle emitter is stored.

Member Function Documentation

copyValue()

void Dragengine.Scenery.ECPParticleEmitter.copyValue	(	ElementClass	elementClass,
		ElementClassProperty	property
	)

Copy value from another element class property of the same type.

Version

1.17

getHasPreloaded()

bool Dragengine.Scenery.ECPParticleEmitter.getHasPreloaded

(

)

Property has been preloaded.

getLoader()

LoadParticleEmitter Dragengine.Scenery.ECPParticleEmitter.getLoader

(

)

Particle emitter loader.

getParticleEmitter()

ParticleEmitter Dragengine.Scenery.ECPParticleEmitter.getParticleEmitter

(

)

ParticleEmitter or null if not present.

getPath()

String Dragengine.Scenery.ECPParticleEmitter.getPath

(

)

Path to particle emitter.

logPreloadProblems()

bool Dragengine.Scenery.ECPParticleEmitter.logPreloadProblems	(	ElementClass	elementClass,
		Console	console
	)

Log preloading problems.

Returns

True if problems are present.

Reimplemented from Dragengine.Scenery.ElementClassProperty.

References Dragengine.Scenery.logPreloadProblems().

new() [1/2]

ECPParticleEmitter Dragengine.Scenery.ECPParticleEmitter.new	(	String	name,
		LoadParticleEmitter	loader
	)

Create property.

new() [2/2]

ECPParticleEmitter Dragengine.Scenery.ECPParticleEmitter.new	(	String	name,
		LoadParticleEmitter	loader,
		String	path
	)

Create property with initial path.

preloadResources()

void Dragengine.Scenery.ECPParticleEmitter.preloadResources	(	ElementClass	elementClass,
		PreloadCounter	counter
	)

Preload resources if supported.

Reimplemented from Dragengine.Scenery.ElementClassProperty.

setParticleEmitter()

void Dragengine.Scenery.ECPParticleEmitter.setParticleEmitter

(

ParticleEmitter

particleEmitter

)

Set particle emitter or null if not present.

setPath()

void Dragengine.Scenery.ECPParticleEmitter.setPath

(

String

path

)

Set path to particle emitter.

setValue()

void Dragengine.Scenery.ECPParticleEmitter.setValue

(

Object

value

)

Set value of property from XML decoded value.

Reimplemented from Dragengine.Scenery.ElementClassProperty.

Member Data Documentation

pException

Exception Dragengine.Scenery.ECPParticleEmitter.pException

pHasPreloaded

bool Dragengine.Scenery.ECPParticleEmitter.pHasPreloaded

pLoader

LoadParticleEmitter Dragengine.Scenery.ECPParticleEmitter.pLoader

pParticleEmitter

ParticleEmitter Dragengine.Scenery.ECPParticleEmitter.pParticleEmitter

pPath

String Dragengine.Scenery.ECPParticleEmitter.pPath

---

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

• ECPParticleEmitter.ds