Dragengine.Scenery.ECPWorld Class Reference

World stub element class property for use with XML loading. More...

Inheritance diagram for Dragengine.Scenery.ECPWorld:

Public Member Functions
void	copyValue (ElementClass elementClass, ElementClassProperty property)
void	dispose ()
	Dispose of element class property to break reference loops.
bool	getHasPreloaded ()
	Property has been preloaded.
LoadWorld	getLoader ()
	World loader.
String	getPath ()
	Path to world.
StubGameWorld	getWorldStub ()
	World stub or null if not present.
StubGameWorld	getWorldStub (StubWithProperties stub, ElementClass eclass)
	World stub modified by stub property if present.
bool	logPreloadProblems (ElementClass elementClass, Console console)
	Log preloading problems.
ECPWorld	new (String name, LoadWorld loader)
	Create property.
ECPWorld	new (String name, LoadWorld loader, String path)
	Create property with initial path.
void	preloadResources (ElementClass elementClass, PreloadCounter counter)
	Preload resources if supported.
void	setPath (String path)
	Set path to world.
void	setValue (Object value)
	Set value of property from XML decoded value.
void	setWorldStub (StubGameWorld stub)
	Set world stub or null if not present.
Public Member Functions inherited from Dragengine.Scenery.ElementClassProperty
String	getName ()
	Name.
ElementClassProperty	new (String name)
	Create property.

Public Attributes
bool	pHasPreloaded
LoadWorld	pLoader
String	pPath
StubGameWorld	pWorldStub

Detailed Description

World stub element class property for use with XML loading.

World stub is set from XML using a path. Loads the world stub during preloading. The value of the property is then the loaded StubGameWorld. If loading fails null is stored.

Warning

The returned StubGameWorld is shared. Do not modify it directly. Instead create a copy of the stub and all its content before using it.

Member Function Documentation

copyValue()

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

dispose()

void Dragengine.Scenery.ECPWorld.dispose

(

)

Dispose of element class property to break reference loops.

Reimplemented from Dragengine.Scenery.ElementClassProperty.

getHasPreloaded()

bool Dragengine.Scenery.ECPWorld.getHasPreloaded

(

)

Property has been preloaded.

getLoader()

LoadWorld Dragengine.Scenery.ECPWorld.getLoader

(

)

World loader.

getPath()

String Dragengine.Scenery.ECPWorld.getPath

(

)

Path to world.

getWorldStub() [1/2]

StubGameWorld Dragengine.Scenery.ECPWorld.getWorldStub

(

)

World stub or null if not present.

getWorldStub() [2/2]

StubGameWorld Dragengine.Scenery.ECPWorld.getWorldStub	(	StubWithProperties	stub,
		ElementClass	eclass
	)

World stub modified by stub property if present.

If named stub property is not present or empty string the stored world stub is returned. If the named stub property is present it is loaded as world stub.

Warning

The returned StubGameWorld is shared. Do not modify it directly. Instead create a copy of the stub and all its content before using it.

References Dragengine.Scenery.logPreloadProblems().

logPreloadProblems()

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

Log preloading problems.

Returns

True if problems are present.

Reimplemented from Dragengine.Scenery.ElementClassProperty.

new() [1/2]

ECPWorld Dragengine.Scenery.ECPWorld.new	(	String	name,
		LoadWorld	loader
	)

Create property.

new() [2/2]

ECPWorld Dragengine.Scenery.ECPWorld.new	(	String	name,
		LoadWorld	loader,
		String	path
	)

Create property with initial path.

preloadResources()

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

Preload resources if supported.

Reimplemented from Dragengine.Scenery.ElementClassProperty.

setPath()

void Dragengine.Scenery.ECPWorld.setPath

(

String

path

)

Set path to world.

setValue()

void Dragengine.Scenery.ECPWorld.setValue

(

Object

value

)

Set value of property from XML decoded value.

Reimplemented from Dragengine.Scenery.ElementClassProperty.

setWorldStub()

void Dragengine.Scenery.ECPWorld.setWorldStub

(

StubGameWorld

stub

)

Set world stub or null if not present.

Member Data Documentation

pHasPreloaded

bool Dragengine.Scenery.ECPWorld.pHasPreloaded

pLoader

LoadWorld Dragengine.Scenery.ECPWorld.pLoader

pPath

String Dragengine.Scenery.ECPWorld.pPath

pWorldStub

StubGameWorld Dragengine.Scenery.ECPWorld.pWorldStub

---

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

• ECPWorld.ds