![]() |
Murl Engine Lua Addon API
Version 1.0 beta
|
Enumeration string mapping template class.
Copy constructor.
Murl.Enum new(Murl.Enum other)
other | The enumeration to copy. |
Get the name of the enumerator.
String GetName()
Get the default enumeration value.
Integer GetDefaultValue()
Get the total number of enumeration entries.
Integer GetCount()
Check if an enumeration value is available.
Boolean IsEnumValueAvailable(Integer value)
value | The enumeration value to check. |
Check if an enumeration name is available.
Boolean IsEnumNameAvailable(String name)
name | The enumeration name to check. |
Get the zero-based index of an enumeration value.
Integer GetEnumIndexByValue(Integer value)
value | The enumeration value to check. |
Get the zero-based index of an enumeration value.
Integer GetEnumIndexByValue(Integer value, Integer hash)
value | The enumeration value to check. |
hash | The precomputed hash value. |
Get the zero-based index of an enumeration name.
Integer GetEnumIndexByName(String name)
name | The enumeration name to check. |
Get the zero-based index of an enumeration name.
Integer GetEnumIndexByName(String name, Integer hash)
name | The enumeration name to check. |
hash | The precomputed hash value. |
Get the enumeration name at a given index.
String GetEnumNameByIndex(Integer index)
index | The index to query, in the range from 0 to GetCount()-1. |
Get the enumeration value at a given index.
Integer GetEnumValueByIndex(Integer index)
index | The index to query, in the range from 0 to GetCount()-1. |
Get the enumeration name for a given enumeration value.
String GetEnumNameByValue(Integer value)
value | The enumeration value to look up. |
Get the enumeration name for a given enumeration value, using a precomputed hash value.
String GetEnumNameByValue(Integer value, Integer hash)
value | The enumeration value to look up. |
hash | The precomputed hash value. |
Get the enumeration name for a given enumeration value, using a precomputed hash value.
String, Boolean GetEnumNameByValue(Integer value, Integer hash, Boolean error)
value | The enumeration value to look up. |
hash | The precomputed hash value. |
error | The error return value is set to true if the value is not found, or false if OK. |
Get the enumeration name for a given enumeration value, using a precomputed hash value.
String, Boolean GetEnumNameByValue(Integer value, Integer hash, Boolean error, Boolean clearError)
value | The enumeration value to look up. |
hash | The precomputed hash value. |
error | The error return value is set to true if the value is not found. |
clearError | If false, the error parameter is left in its given state if no error occurred. |
Get the enumeration name for a given enumeration value.
String, Boolean GetEnumNameByValue(Integer value, Boolean error)
value | The enumeration value to look up. |
error | The error return value is set to true if the value is not found, or false if OK. |
Get the enumeration name for a given enumeration value.
String, Boolean GetEnumNameByValue(Integer value, Boolean error, Boolean clearError)
value | The enumeration value to look up. |
error | The error return value is set to true if the value is not found. |
clearError | If false, the error parameter is left in its given state if no error occurred. |
Get the enumeration value for a given enumeration name.
Integer GetEnumValueByName(String name)
name | The name string to look up. |
Get the enumeration value for a given enumeration name, using a precomputed hash value.
Integer GetEnumValueByName(String name, Integer hash)
name | The name string to look up. |
hash | The precomputed hash value. |
Get the enumeration value for a given enumeration name, using a precomputed hash value.
Integer, Boolean GetEnumValueByName(String name, Integer hash, Boolean error)
name | The name string to look up. |
hash | The precomputed hash value. |
error | The error return value is set to true if the value is not found, or false if OK. |
Get the enumeration value for a given enumeration name, using a precomputed hash value.
Integer, Boolean GetEnumValueByName(String name, Integer hash, Boolean error, Boolean clearError)
name | The name string to look up. |
hash | The precomputed hash value. |
error | The error return value is set to true if the name is not found. |
clearError | If false, the error parameter is left in its given state if no error occurred. |
Get the enumeration value for a given enumeration name.
Integer, Boolean GetEnumValueByName(String name, Boolean error)
name | The name string to look up. |
error | The error return value is set to true if the value is not found, or false if OK. |
Get the enumeration value for a given enumeration name.
Integer, Boolean GetEnumValueByName(String name, Boolean error, Boolean clearError)
name | The name string to look up. |
error | The error return value is set to true if the name is not found. |
clearError | If false, the error parameter is left in its given state if no error occurred. |
Get the enumeration values by name map.
Murl.Map.StringUInt32 GetItemsByName()
Get the names by enumeration value map.
Murl.Map.UInt32String GetItemsByValue()
The length operator is denoted by the unary prefix operator #.
Converts the object content to a string in a reasonable format.