Enumeration value element class property for use with XML loading. More...
Public Member Functions | |
| void | copyValue (ElementClass elementClass, ElementClassProperty property) |
| Copy value from another element class property of the same type. More... | |
| Enumeration | getEnumeration (StubWithProperties stub) |
| Enumeration value modified by stub property if present. More... | |
| Dictionary | getMapping () |
| Mapping between strings and enumerations. More... | |
| ECPEnumeration | new (String name, Enumeration value) |
| Create property. More... | |
| ECPEnumeration | new (String name, Set enumerationValues, Enumeration value) |
| void | setEnumeration (Enumeration value) |
| Set value. More... | |
| void | setMapping (Dictionary mapping) |
| Set mapping between strings and enumerations. More... | |
| void | setMapping (Set enumerationValues) |
| Set mapping from set of enumeration values. 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... | |
| void | setValue (Object value) |
| Set value of property from XML decoded value. More... | |
Detailed Description
Enumeration value element class property for use with XML loading.
Value is an Enumeration value using a dictionary mapping string values to enumeration values.
Member Function Documentation
◆ copyValue()
| void Dragengine.Scenery.ECPEnumeration.copyValue | ( | ElementClass | elementClass, |
| ElementClassProperty | property | ||
| ) |
Copy value from another element class property of the same type.
- Version
- 1.17
◆ getEnumeration()
| Enumeration Dragengine.Scenery.ECPEnumeration.getEnumeration | ( | 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.
◆ getMapping()
| Dictionary Dragengine.Scenery.ECPEnumeration.getMapping | ( | ) |
Mapping between strings and enumerations.
◆ new() [1/2]
| ECPEnumeration Dragengine.Scenery.ECPEnumeration.new | ( | String | name, |
| Enumeration | value | ||
| ) |
Create property.
◆ new() [2/2]
| ECPEnumeration Dragengine.Scenery.ECPEnumeration.new | ( | String | name, |
| Set | enumerationValues, | ||
| Enumeration | value | ||
| ) |
◆ setEnumeration()
| void Dragengine.Scenery.ECPEnumeration.setEnumeration | ( | Enumeration | value | ) |
Set value.
Allowed if enumeration is part of mapping.
◆ setMapping() [1/2]
| void Dragengine.Scenery.ECPEnumeration.setMapping | ( | Dictionary | mapping | ) |
Set mapping between strings and enumerations.
◆ setMapping() [2/2]
| void Dragengine.Scenery.ECPEnumeration.setMapping | ( | Set | enumerationValues | ) |
Set mapping from set of enumeration values.
Uses enumeration name as mapping name.
The documentation for this class was generated from the following file:
