Dragengine.Scenery.ECPSky Class Reference

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

Inheritance diagram for Dragengine.Scenery.ECPSky:

Public Member Functions
void	copyValue (ElementClass elementClass, ElementClassProperty property)
	Copy value from another element class property of the same type. More...
bool	getHasPreloaded ()
	Property has been preloaded. More...
LoadSky	getLoader ()
	Sky loader. More...
String	getPath ()
	Path to sky. More...
Sky	getSky ()
	Sky or null if not present. More...
Sky	getSky (StubWithProperties stub, ElementClass eclass)
	Sky modified by stub property if present. More...
bool	logPreloadProblems (ElementClass elementClass, Console console)
	Log preloading problems. More...
ECPSky	new (String name, LoadSky loader)
	Create property. More...
ECPSky	new (String name, LoadSky loader, String path)
	Create property with initial path. More...
void	preloadResources (ElementClass elementClass, PreloadCounter counter)
	Preload resources if supported. More...
void	setPath (String path)
	Set path to sky. More...
void	setSky (Sky sky)
	Set sky or null if not present. More...
void	setValue (Object value)
	Set value of property from XML decoded value. More...
Public Member Functions inherited from Dragengine.Scenery.ElementClassProperty
void	dispose ()
	Dispose of element class property to break reference loops. More...
String	getName ()
	Name. More...
ElementClassProperty	new (String name)
	Create property. More...

Detailed Description

Sky element class property for use with XML loading.

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

Member Function Documentation

copyValue()

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

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

Version

1.17

getHasPreloaded()

bool Dragengine.Scenery.ECPSky.getHasPreloaded

(

)

Property has been preloaded.

getLoader()

LoadSky Dragengine.Scenery.ECPSky.getLoader

(

)

Sky loader.

getPath()

String Dragengine.Scenery.ECPSky.getPath

(

)

Path to sky.

getSky() [1/2]

Sky Dragengine.Scenery.ECPSky.getSky

(

)

Sky or null if not present.

getSky() [2/2]

Sky Dragengine.Scenery.ECPSky.getSky	(	StubWithProperties	stub,
		ElementClass	eclass
	)

Sky modified by stub property if present.

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

logPreloadProblems()

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

Log preloading problems.

Returns

True if problems are present.

Reimplemented from Dragengine.Scenery.ElementClassProperty.

new() [1/2]

ECPSky Dragengine.Scenery.ECPSky.new	(	String	name,
		LoadSky	loader
	)

Create property.

new() [2/2]

ECPSky Dragengine.Scenery.ECPSky.new	(	String	name,
		LoadSky	loader,
		String	path
	)

Create property with initial path.

preloadResources()

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

Preload resources if supported.

Reimplemented from Dragengine.Scenery.ElementClassProperty.

setPath()

void Dragengine.Scenery.ECPSky.setPath

(

String

path

)

Set path to sky.

setSky()

void Dragengine.Scenery.ECPSky.setSky

(

Sky

sky

)

Set sky or null if not present.

setValue()

void Dragengine.Scenery.ECPSky.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:

• ECPSky.ds