Dragengine.Scenery.ECPElementClass Class Reference

Element class element class property for use with XML loading. More...

Inheritance diagram for Dragengine.Scenery.ECPElementClass:

Public Member Functions
void	copyValue (ElementClass elementClass, ElementClassProperty property)
	Copy value from another element class property of the same type. More...
void	dispose ()
	Dispose of element class property to break reference loops. More...
ElementClass	getElementClass ()
	Element class or null if not found. More...
ElementClass	getElementClass (StubWithProperties stub)
	Element class modified by stub property if present. More...
ElementClassList	getElementClassList ()
	Element class manager to look up element class in. More...
String	getElementClassName ()
	Name of element class. More...
bool	getHasPreloaded ()
	Property has been preloaded. More...
bool	logPreloadProblems (ElementClass elementClass, Console console)
	Log preloading problems. More...
ECPElementClass	new (String name, ElementClassList elementClassList)
	Create property. More...
ECPElementClass	new (String name, ElementClassList elementClassList, String elementClassName)
	Create property with initial element class name. More...
void	preloadResources (ElementClass elementClass, PreloadCounter counter)
	Preload resources if supported. More...
void	setElementClass (ElementClass elementClass)
	Set element class or null if not found. More...
void	setElementClassName (String elementClassName)
	Set name of element class. More...
void	setValue (Object value)
	Set value of property from XML decoded value. More...
Public Member Functions inherited from Dragengine.Scenery.ElementClassProperty
String	getName ()
	Name. More...
ElementClassProperty	new (String name)
	Create property. More...

Detailed Description

Element class element class property for use with XML loading.

Element class is set from XML using a string. Looks up the matching element class during preloading. The value of the property is then the real element class or null if not found.

Member Function Documentation

copyValue()

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

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

Version

1.17

dispose()

void Dragengine.Scenery.ECPElementClass.dispose

(

)

Dispose of element class property to break reference loops.

Reimplemented from Dragengine.Scenery.ElementClassProperty.

getElementClass() [1/2]

ElementClass Dragengine.Scenery.ECPElementClass.getElementClass

(

)

Element class or null if not found.

getElementClass() [2/2]

ElementClass Dragengine.Scenery.ECPElementClass.getElementClass

(

StubWithProperties

stub

)

Element class modified by stub property if present.

If named stub property is not present or empty string the stored element class is returned. If the named stub property is present it is matched against the list of element classes.

getElementClassList()

ElementClassList Dragengine.Scenery.ECPElementClass.getElementClassList

(

)

Element class manager to look up element class in.

getElementClassName()

String Dragengine.Scenery.ECPElementClass.getElementClassName

(

)

Name of element class.

getHasPreloaded()

bool Dragengine.Scenery.ECPElementClass.getHasPreloaded

(

)

Property has been preloaded.

logPreloadProblems()

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

Log preloading problems.

Returns

True if problems are present.

Reimplemented from Dragengine.Scenery.ElementClassProperty.

new() [1/2]

ECPElementClass Dragengine.Scenery.ECPElementClass.new	(	String	name,
		ElementClassList	elementClassList
	)

Create property.

new() [2/2]

ECPElementClass Dragengine.Scenery.ECPElementClass.new	(	String	name,
		ElementClassList	elementClassList,
		String	elementClassName
	)

Create property with initial element class name.

preloadResources()

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

Preload resources if supported.

Reimplemented from Dragengine.Scenery.ElementClassProperty.

setElementClass()

void Dragengine.Scenery.ECPElementClass.setElementClass

(

ElementClass

elementClass

)

Set element class or null if not found.

setElementClassName()

void Dragengine.Scenery.ECPElementClass.setElementClassName

(

String

elementClassName

)

Set name of element class.

setValue()

void Dragengine.Scenery.ECPElementClass.setValue

(

Object

value

)

Set value of property from XML decoded value.

Reimplemented from Dragengine.Scenery.ElementClassProperty.

---

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

• ECPElementClass.ds