Drag[en]gine Script Module DragonScript  1.23
Dragengine.Scenery.ECPAnnouncer Class Reference

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

Inheritance diagram for Dragengine.Scenery.ECPAnnouncer:
Dragengine.Scenery.ElementClassProperty Dragengine.Preloading.PreloadListener

Public Member Functions

void copyValue (ElementClass elementClass, ElementClassProperty property)
 Copy value from another element class property of the same type. More...
 
Announcer getAnnouncer ()
 Announcer or null if not present. More...
 
Announcer getAnnouncer (StubWithProperties stub, ElementClass eclass)
 Announcer modified by stub property if present. More...
 
bool getHasPreloaded ()
 Property has been preloaded. More...
 
LoadAnnouncer getLoader ()
 Announcer loader. More...
 
String getPath ()
 Path to announcer. More...
 
bool logPreloadProblems (ElementClass elementClass, Console console)
 Log preloading problems. More...
 
ECPAnnouncer new (String name, LoadAnnouncer loader)
 Create property. More...
 
ECPAnnouncer new (String name, LoadAnnouncer loader, String path)
 Create property with initial path. More...
 
void preloadingFinished (Preloader preloader, bool success)
 Preloading of all resources finished.
More...
 
void preloadResources (ElementClass elementClass, PreloadCounter counter)
 Preload resources if supported. More...
 
void resourcesFinished (Preloader preloader)
 One or more resources finished preloading but not all yet. More...
 
void setAnnouncer (Announcer announcer)
 Set announcer or null if not present. More...
 
void setPath (String path)
 Set path to announcer. 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

Announcer element class property for use with XML loading.

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

Member Function Documentation

◆ copyValue()

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

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

Version
1.17

◆ getAnnouncer() [1/2]

Announcer Dragengine.Scenery.ECPAnnouncer.getAnnouncer ( )

Announcer or null if not present.

◆ getAnnouncer() [2/2]

Announcer Dragengine.Scenery.ECPAnnouncer.getAnnouncer ( StubWithProperties  stub,
ElementClass  eclass 
)

Announcer modified by stub property if present.

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

◆ getHasPreloaded()

bool Dragengine.Scenery.ECPAnnouncer.getHasPreloaded ( )

Property has been preloaded.

◆ getLoader()

LoadAnnouncer Dragengine.Scenery.ECPAnnouncer.getLoader ( )

Announcer loader.

◆ getPath()

String Dragengine.Scenery.ECPAnnouncer.getPath ( )

Path to announcer.

◆ logPreloadProblems()

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

Log preloading problems.

Returns
True if problems are present.

Reimplemented from Dragengine.Scenery.ElementClassProperty.

◆ new() [1/2]

ECPAnnouncer Dragengine.Scenery.ECPAnnouncer.new ( String  name,
LoadAnnouncer  loader 
)

Create property.

◆ new() [2/2]

ECPAnnouncer Dragengine.Scenery.ECPAnnouncer.new ( String  name,
LoadAnnouncer  loader,
String  path 
)

Create property with initial path.

◆ preloadingFinished()

void Dragengine.Scenery.ECPAnnouncer.preloadingFinished ( Preloader  preloader,
bool  success 
)

Preloading of all resources finished.

Implements Dragengine.Preloading.PreloadListener.

◆ preloadResources()

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

Preload resources if supported.

Reimplemented from Dragengine.Scenery.ElementClassProperty.

◆ resourcesFinished()

void Dragengine.Scenery.ECPAnnouncer.resourcesFinished ( Preloader  preloader)

One or more resources finished preloading but not all yet.

Implements Dragengine.Preloading.PreloadListener.

◆ setAnnouncer()

void Dragengine.Scenery.ECPAnnouncer.setAnnouncer ( Announcer  announcer)

Set announcer or null if not present.

◆ setPath()

void Dragengine.Scenery.ECPAnnouncer.setPath ( String  path)

Set path to announcer.

◆ setValue()

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