Drag[en]gine Script Module DragonScript  1.23
Dragengine.Commands.CommandsBAAMovement.AnalogMoveFB Class Reference

Analog movement forward/backward. More...

Inheritance diagram for Dragengine.Commands.CommandsBAAMovement.AnalogMoveFB:
Dragengine.Commands.CommandsBAAMovement.Base Dragengine.Commands.Command

Public Member Functions

void analogAbsolute (BAAMovement action, float value)
 Absolute input device axis position changed. More...
 
void analogRelative (BAAMovement action, float value)
 Relative input device axis position changed. More...
 
AnalogMoveFB new (ECBehaviorPlayerControllable.Tracker tracker)
 
AnalogMoveFB new (ECBehaviorPlayerControllable.Tracker tracker, String name)
 
- Public Member Functions inherited from Dragengine.Commands.CommandsBAAMovement.Base
void analogAbsolute (float value)
 Absolute input device axis position changed. More...
 
void analogRelative (float value)
 Relative input device axis position changed. More...
 
Base new (ECBehaviorPlayerControllable.Tracker tracker, String name, String description)
 
void start ()
 Input device key or button has been pressed. More...
 
void start (BAAMovement action)
 Start command on action. More...
 
void stop ()
 Input device key or button has been released. More...
 
void stop (BAAMovement action)
 Start command on action. More...
 
- Public Member Functions inherited from Dragengine.Commands.Command
String getDescription ()
 Description. More...
 
String getDisplayName ()
 Display name or null. More...
 
String getName ()
 Unique name. More...
 
String getTranslateDescription ()
 Translation description or null. More...
 
String getTranslateDisplayName ()
 Translation display name or null. 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 setDisplayName (String displayName)
 Set display name or null. More...
 
void setName (String name)
 Set unique name of the command. More...
 
void setTranslateDescription (String translateName)
 Set translate description or null. More...
 
void setTranslateDisplayName (String translateName)
 Set translate display name or null. More...
 
void touch ()
 Input device button has been touched. More...
 
String translateDescription ()
 Translated command description using default TranslationManager. More...
 
String translateDescription (TranslationManager translationManager)
 Translated command description. More...
 
String translateDisplayName ()
 Translated display name using default TranslationManager. More...
 
String translateDisplayName (TranslationManager translationManager)
 Translated display name. More...
 
void untouch ()
 Input device button has been untouched. More...
 

Additional Inherited Members

- Public Attributes inherited from Dragengine.Commands.CommandsBAAMovement.Base
ECBehaviorPlayerControllable.Tracker pTracker
 
- Protected Member Functions inherited from Dragengine.Commands.CommandsBAAMovement.Base
BAAMovement getMovement ()
 
ECBehaviorPlayerControllable.Tracker getTracker ()
 

Detailed Description

Analog movement forward/backward.

Member Function Documentation

◆ analogAbsolute()

void Dragengine.Commands.CommandsBAAMovement.AnalogMoveFB.analogAbsolute ( BAAMovement  action,
float  value 
)

Absolute input device axis position changed.

Axis keeps position until next event. Gamepad events typically send this method when the stick is pushed to a new position.

Parameters
valueNew axis position in the range -1 to 1.

Reimplemented from Dragengine.Commands.CommandsBAAMovement.Base.

◆ analogRelative()

void Dragengine.Commands.CommandsBAAMovement.AnalogMoveFB.analogRelative ( BAAMovement  action,
float  value 
)

Relative input device axis position changed.

Value is the change in the relative axis. It is reset to 0 right after sending the event. No event is sent for the reset. A typical device is mouse movement resulting in this method to be called.

Parameters
valueRelative axis position change in axis units. Caller is responsible to adjust the range to make different input devices match in magnitude.

Reimplemented from Dragengine.Commands.CommandsBAAMovement.Base.

◆ new() [1/2]

AnalogMoveFB Dragengine.Commands.CommandsBAAMovement.AnalogMoveFB.new ( ECBehaviorPlayerControllable.Tracker  tracker)

◆ new() [2/2]

AnalogMoveFB Dragengine.Commands.CommandsBAAMovement.AnalogMoveFB.new ( ECBehaviorPlayerControllable.Tracker  tracker,
String  name 
)

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