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

List of string identifier values class property for use with XML loading. More...

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

Public Member Functions

void add (StringID string)
 Add string identifier. More...
 
void forEach (Block ablock)
 For each string identifier with block with String as parameter. More...
 
StringID getAt (int index)
 String identifier at index. More...
 
int getCount ()
 Number of string identifiers. More...
 
Array getList (StubWithProperties stub, CodecPropertyString codec)
 StringID list modified by stub property if present. More...
 
StringID getRandom ()
 Get random string identifier or null if no string identifiers are present. More...
 
ECPStringIDList new (String name)
 Create property. More...
 
void removeAll ()
 Remove all string identifiers. 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...
 

Detailed Description

List of string identifier values class property for use with XML loading.

Member Function Documentation

◆ add()

void Dragengine.Scenery.ECPStringIDList.add ( StringID  string)

Add string identifier.

◆ forEach()

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

For each string identifier with block with String as parameter.

◆ getAt()

StringID Dragengine.Scenery.ECPStringIDList.getAt ( int  index)

String identifier at index.

◆ getCount()

int Dragengine.Scenery.ECPStringIDList.getCount ( )

Number of string identifiers.

◆ getList()

Array Dragengine.Scenery.ECPStringIDList.getList ( StubWithProperties  stub,
CodecPropertyString  codec 
)

StringID list modified by stub property if present.

If named stub property is not present or empty string the stored list is returned. If the named stub property is present it is decoded using codec.

  • "id1 id2 ... idN"

◆ getRandom()

StringID Dragengine.Scenery.ECPStringIDList.getRandom ( )

Get random string identifier or null if no string identifiers are present.

◆ new()

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

Create property.

Reimplemented from Dragengine.Scenery.ElementClassProperty.

◆ removeAll()

void Dragengine.Scenery.ECPStringIDList.removeAll ( )

Remove all string identifiers.

◆ setValue()

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