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

Integer enumeration value element class property for use with XML loading. More...

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

Public Member Functions

void copyValue (ElementClass elementClass, ElementClassProperty property)
 Copy value from another element class property of the same type. More...
 
Dictionary getMapping ()
 Mapping between strings and enumerations. More...
 
int getValue ()
 Value. More...
 
int getValue (StubWithProperties stub)
 Enumeration value modified by stub property if present. More...
 
ECPEnumerationInt new (String name, int value)
 Create property. More...
 
void setMapping (Dictionary mapping)
 Set mapping between strings and enumerations. More...
 
void setValue (int value)
 Set value. 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...
 
ElementClassProperty new (String name)
 Create property. More...
 
void preloadResources (ElementClass elementClass, PreloadCounter counter)
 Preload resources if supported. More...
 

Detailed Description

Integer enumeration value element class property for use with XML loading.

Value is an integer value using a dictionary mapping string values to enumeration values.

Member Function Documentation

◆ copyValue()

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

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

Version
1.17

◆ getMapping()

Dictionary Dragengine.Scenery.ECPEnumerationInt.getMapping ( )

Mapping between strings and enumerations.

◆ getValue() [1/2]

int Dragengine.Scenery.ECPEnumerationInt.getValue ( )

Value.

◆ getValue() [2/2]

int Dragengine.Scenery.ECPEnumerationInt.getValue ( StubWithProperties  stub)

Enumeration value modified by stub property if present.

If named stub property is not present or empty string the stored enumeration value is returned. If the named stub property is present it is mapped against the mapping and the matching enumeration value returned. If no match is found an exception is thrown.

◆ new()

ECPEnumerationInt Dragengine.Scenery.ECPEnumerationInt.new ( String  name,
int  value 
)

Create property.

◆ setMapping()

void Dragengine.Scenery.ECPEnumerationInt.setMapping ( Dictionary  mapping)

Set mapping between strings and enumerations.

◆ setValue() [1/2]

void Dragengine.Scenery.ECPEnumerationInt.setValue ( int  value)

Set value.

◆ setValue() [2/2]

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