Drag[en]gine Script Module DragonScript Script API  1.0
ModuleParameter Class Reference

Module parameter. More...

Inheritance diagram for ModuleParameter:

Public Member Functions

Constructors
ModuleParameter new ()
 Create module parameter. More...
 
Management
String getName ()
 Unique name. More...
 
String getDescription ()
 Description. More...
 
int getType ()
 Type. More...
 
float getMinimumValue ()
 Minimum value. More...
 
float getMaximumValue ()
 Maximum value. More...
 
float getValueStepSize ()
 Value step. More...
 
int getSelectionEntryCount ()
 Number of select entries. More...
 
String getSelectionEntryAt (int index)
 Select entry name at index. More...
 

Static Public Attributes

static final int BOOLEAN = 0
 Boolean value. More...
 
static final int NUMERIC = 1
 Numeric value. More...
 
static final int RANGED = 2
 Ranged value which has to be inside a given range. More...
 
static final int SELECTION = 3
 Value from a selection of values. More...
 

Detailed Description

Module parameter.

This is a native class.

Author
Roland Pl├╝ss
Version
1.0
Date
2015

Member Function Documentation

§ getDescription()

String getDescription ( )

Description.

§ getMaximumValue()

float getMaximumValue ( )

Maximum value.

§ getMinimumValue()

float getMinimumValue ( )

Minimum value.

§ getName()

String getName ( )

Unique name.

§ getSelectionEntryAt()

String getSelectionEntryAt ( int  index)

Select entry name at index.

Exceptions
EOutOfBoundaryindex is less than 0 or larger than or equal to getSelectCount().

§ getSelectionEntryCount()

int getSelectionEntryCount ( )

Number of select entries.

§ getType()

int getType ( )

Type.

§ getValueStepSize()

float getValueStepSize ( )

Value step.

§ new()

ModuleParameter new ( )

Create module parameter.

Member Data Documentation

§ BOOLEAN

final int BOOLEAN = 0
static

Boolean value.

§ NUMERIC

final int NUMERIC = 1
static

Numeric value.

§ RANGED

final int RANGED = 2
static

Ranged value which has to be inside a given range.

§ SELECTION

final int SELECTION = 3
static

Value from a selection of values.


The documentation for this class was generated from the following file: