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

List of skin resource elements class property for use with XML loading. More...

Inheritance diagram for Dragengine.Scenery.ECPSkinList:
Dragengine.Scenery.ElementClassProperty Dragengine.ResourceListener

Public Member Functions

void add (Skin skin)
 Add skin. More...
 
void addPath (String path)
 Add a path. More...
 
void forEach (Block ablock)
 For each skin with block with Skin as parameter. More...
 
void forEachPath (Block ablock)
 For each path with block with String as parameter. More...
 
Skin getAt (int index)
 Skin at index. More...
 
int getCount ()
 Number of skins. More...
 
bool getHasPreloaded ()
 Property has been preloaded. More...
 
String getPathAt (int index)
 path at index. More...
 
int getPathCount ()
 Count of path. More...
 
Skin getRandom ()
 Get random skin or null if no skins are present. More...
 
ECPSkinList new (String name)
 Create property. More...
 
void removeAll ()
 Remove all skins. More...
 
void removeAllPath ()
 Remove all path. 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...
 
bool logPreloadProblems (ElementClass elementClass, Console console)
 Log preloading problems. More...
 
void preloadResources (ElementClass elementClass, PreloadCounter counter)
 Preload resources if supported. More...
 
- Public Member Functions inherited from Dragengine.ResourceListener
void finishedLoading (String filename, ResourceLoaderType resourceType, Object resource)
 Resource finished loading successfully. More...
 
void failedLoading (String filename, ResourceLoaderType resourceType)
 Resource failed loading. More...
 

Detailed Description

List of skin resource elements class property for use with XML loading.

Similar to ECPSkin but allows to stored any number of skins. Useful for having a list of similar skins picking randomly one to play.

By default empty path does not add a skin. If you need the size of the skin list to be identical to the list of skin path specified use set add null for invalid skins to true. In this case for all skin path that are empty or fail to load null is added to the list.

Member Function Documentation

◆ add()

void Dragengine.Scenery.ECPSkinList.add ( Skin  skin)

Add skin.

◆ addPath()

void Dragengine.Scenery.ECPSkinList.addPath ( String  path)

Add a path.

◆ forEach()

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

For each skin with block with Skin as parameter.

◆ forEachPath()

void Dragengine.Scenery.ECPSkinList.forEachPath ( Block  ablock)

For each path with block with String as parameter.

Version
1.19

◆ getAt()

Skin Dragengine.Scenery.ECPSkinList.getAt ( int  index)

Skin at index.

◆ getCount()

int Dragengine.Scenery.ECPSkinList.getCount ( )

Number of skins.

◆ getHasPreloaded()

bool Dragengine.Scenery.ECPSkinList.getHasPreloaded ( )

Property has been preloaded.

◆ getPathAt()

String Dragengine.Scenery.ECPSkinList.getPathAt ( int  index)

path at index.

Version
1.19

◆ getPathCount()

int Dragengine.Scenery.ECPSkinList.getPathCount ( )

Count of path.

Version
1.19

◆ getRandom()

Skin Dragengine.Scenery.ECPSkinList.getRandom ( )

Get random skin or null if no skins are present.

◆ new()

ECPSkinList Dragengine.Scenery.ECPSkinList.new ( String  name)

Create property.

Reimplemented from Dragengine.Scenery.ElementClassProperty.

◆ removeAll()

void Dragengine.Scenery.ECPSkinList.removeAll ( )

Remove all skins.

◆ removeAllPath()

void Dragengine.Scenery.ECPSkinList.removeAllPath ( )

Remove all path.

◆ setValue()

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