Drag[en]gine Script Module DragonScript  1.21
Dragengine.Scenery.ECPAnimatorMap Class Reference

Dictionary of animators element class property for use with XML loading. More...

Inheritance diagram for Dragengine.Scenery.ECPAnimatorMap:
Dragengine.Scenery.ElementClassProperty

Public Member Functions

void dispose ()
 Dispose of element class property to break reference loops. More...
 
void forEach (Block ablock)
 Visit animators with block with String id and Animator value. More...
 
Animator getAt (String id)
 Animator with identifier or null if absent. More...
 
int getCount ()
 Number of animators. More...
 
bool getHasPreloaded ()
 Property has been preloaded. More...
 
LoadAnimator getLoader ()
 Animator loader. More...
 
ECPAnimatorMap new (String name, LoadAnimator loader)
 Create property. More...
 
void removeAll ()
 Remove all animators. More...
 
void removeAllPath ()
 Remove all path. More...
 
void setAt (String id, Animator animator)
 Set animator for identifier. More...
 
void setPathAt (String id, String path)
 Set path to load for identifier. 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...
 
bool logPreloadProblems (ElementClass elementClass, Console console)
 Log preloading problems. More...
 
ElementClassProperty new (String name)
 Create property. More...
 
void preloadResources (ElementClass elementClass, PreloadCounter counter)
 Preload resources if supported. More...
 

Detailed Description

Dictionary of animators element class property for use with XML loading.

Similar to ECPAnimator but assigns each animator a unique name. This is useful to define a list of animators to use mapped against well known identifiers. Also allows to map the same animator to multiple unique identifiers if required.

Member Function Documentation

◆ dispose()

void Dragengine.Scenery.ECPAnimatorMap.dispose ( )

Dispose of element class property to break reference loops.

Reimplemented from Dragengine.Scenery.ElementClassProperty.

◆ forEach()

void Dragengine.Scenery.ECPAnimatorMap.forEach ( Block  ablock)

Visit animators with block with String id and Animator value.

◆ getAt()

Animator Dragengine.Scenery.ECPAnimatorMap.getAt ( String  id)

Animator with identifier or null if absent.

◆ getCount()

int Dragengine.Scenery.ECPAnimatorMap.getCount ( )

Number of animators.

◆ getHasPreloaded()

bool Dragengine.Scenery.ECPAnimatorMap.getHasPreloaded ( )

Property has been preloaded.

◆ getLoader()

LoadAnimator Dragengine.Scenery.ECPAnimatorMap.getLoader ( )

Animator loader.

◆ new()

ECPAnimatorMap Dragengine.Scenery.ECPAnimatorMap.new ( String  name,
LoadAnimator  loader 
)

Create property.

◆ removeAll()

void Dragengine.Scenery.ECPAnimatorMap.removeAll ( )

Remove all animators.

◆ removeAllPath()

void Dragengine.Scenery.ECPAnimatorMap.removeAllPath ( )

Remove all path.

◆ setAt()

void Dragengine.Scenery.ECPAnimatorMap.setAt ( String  id,
Animator  animator 
)

Set animator for identifier.

◆ setPathAt()

void Dragengine.Scenery.ECPAnimatorMap.setPathAt ( String  id,
String  path 
)

Set path to load for identifier.

◆ setValue()

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