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

Command carrying out a specific task. More...

Inheritance diagram for Command:
CommandScreenshot

Public Member Functions

void analog (float movement)
 Analog movement due to input device axis changing position. More...
 
String getDescription ()
 Description. More...
 
String getName ()
 Unique name. More...
 
Command new ()
 Create command. More...
 
Command new (String name, String description)
 Create command. More...
 
void pulse ()
 Convenience method calling start() and stop() in succession. More...
 
void setDescription (String description)
 Set description. More...
 
void setName (String name)
 Set unique name of the command. More...
 
void start ()
 Input key or button has been pressed. More...
 
void stop ()
 Input key or button has been released. More...
 

Detailed Description

Command carrying out a specific task.

Can be bound to player input events or used in widgets.

Member Function Documentation

§ analog()

void analog ( float  movement)

Analog movement due to input device axis changing position.

Parameters
movementDifference from the old position to the new position.

§ getDescription()

String getDescription ( )

Description.

§ getName()

String getName ( )

Unique name.

§ new() [1/2]

Command new ( )

Create command.

§ new() [2/2]

Command new ( String  name,
String  description 
)

Create command.

§ pulse()

void pulse ( )

Convenience method calling start() and stop() in succession.

Used for example to run the command for different reasons than input handling.

§ setDescription()

void setDescription ( String  description)

Set description.

§ setName()

void setName ( String  name)

Set unique name of the command.

Allowed are only upper and lower case letters, numbers and underscores.

§ start()

void start ( )

Input key or button has been pressed.

§ stop()

void stop ( )

Input key or button has been released.


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