Dragengine.ModuleParameter Class Reference
Module parameter. More...
Inheritance diagram for Dragengine.ModuleParameter:
Public Member Functions | |
Constructors | |
| ModuleParameter | new () |
| Create module parameter. More... | |
Management | |
| String | getName () |
| Unique name. More... | |
| String | getDescription () |
| Description. More... | |
| ModuleParameterType | getType () |
| Type. More... | |
| float | getMinimumValue () |
| Minimum value. More... | |
| float | getMaximumValue () |
| Maximum value. More... | |
| float | getValueStepSize () |
| Value step. More... | |
| int | getSelectionEntryCount () |
| Count of selection entries. More... | |
| String | getSelectionEntryValueAt (int index) |
| Value of selection entry at index. More... | |
| String | getSelectionEntryDisplayNameAt (int index) |
| Display name of selection entry at index. More... | |
| String | getSelectionEntryDescriptionAt (int index) |
| Description of selection entry at index. More... | |
| ModuleParameterCategory | getCategory () |
| Display category. More... | |
| String | getDisplayName () |
| Display name for use in configuration dialogs. More... | |
| String | getDefaultValue () |
| Default value. More... | |
Detailed Description
Module parameter.
This is a native class.
Member Function Documentation
◆ getCategory()
| ModuleParameterCategory Dragengine.ModuleParameter.getCategory | ( | ) |
Display category.
◆ getDefaultValue()
| String Dragengine.ModuleParameter.getDefaultValue | ( | ) |
Default value.
- Version
- 1.7
◆ getDescription()
| String Dragengine.ModuleParameter.getDescription | ( | ) |
Description.
◆ getDisplayName()
| String Dragengine.ModuleParameter.getDisplayName | ( | ) |
Display name for use in configuration dialogs.
◆ getMaximumValue()
| float Dragengine.ModuleParameter.getMaximumValue | ( | ) |
Maximum value.
◆ getMinimumValue()
| float Dragengine.ModuleParameter.getMinimumValue | ( | ) |
Minimum value.
◆ getName()
| String Dragengine.ModuleParameter.getName | ( | ) |
Unique name.
◆ getSelectionEntryCount()
| int Dragengine.ModuleParameter.getSelectionEntryCount | ( | ) |
Count of selection entries.
◆ getSelectionEntryDescriptionAt()
| String Dragengine.ModuleParameter.getSelectionEntryDescriptionAt | ( | int | index | ) |
Description of selection entry at index.
- Exceptions
-
EOutOfBoundary index is less than 0 or larger than or equal to getSelectCount().
◆ getSelectionEntryDisplayNameAt()
| String Dragengine.ModuleParameter.getSelectionEntryDisplayNameAt | ( | int | index | ) |
Display name of selection entry at index.
- Exceptions
-
EOutOfBoundary index is less than 0 or larger than or equal to getSelectCount().
◆ getSelectionEntryValueAt()
| String Dragengine.ModuleParameter.getSelectionEntryValueAt | ( | int | index | ) |
Value of selection entry at index.
- Exceptions
-
EOutOfBoundary index is less than 0 or larger than or equal to getSelectCount().
◆ getType()
| ModuleParameterType Dragengine.ModuleParameter.getType | ( | ) |
Type.
◆ getValueStepSize()
| float Dragengine.ModuleParameter.getValueStepSize | ( | ) |
Value step.
◆ new()
| ModuleParameter Dragengine.ModuleParameter.new | ( | ) |
Create module parameter.
The documentation for this class was generated from the following file:
