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

Base class operating only on actors with BAAMovement action. More...

Inheritance diagram for Dragengine.Commands.CommandsBAAMovement.Base:
Dragengine.Commands.Command Dragengine.Commands.CommandsBAAMovement.AnalogLookLR Dragengine.Commands.CommandsBAAMovement.AnalogLookUD Dragengine.Commands.CommandsBAAMovement.AnalogMoveFB Dragengine.Commands.CommandsBAAMovement.AnalogMoveLR Dragengine.Commands.CommandsBAAMovement.Crouch Dragengine.Commands.CommandsBAAMovement.LookDown Dragengine.Commands.CommandsBAAMovement.LookLeft Dragengine.Commands.CommandsBAAMovement.LookRight Dragengine.Commands.CommandsBAAMovement.LookUp Dragengine.Commands.CommandsBAAMovement.MoveBackward Dragengine.Commands.CommandsBAAMovement.MoveForward Dragengine.Commands.CommandsBAAMovement.MoveLeft Dragengine.Commands.CommandsBAAMovement.MoveRight Dragengine.Commands.CommandsBAAMovement.Run Dragengine.Commands.CommandsBAAMovement.ToggleCrouch Dragengine.Commands.CommandsBAAMovement.ToggleRun

Public Member Functions

void analogAbsolute (BAAMovement action, float value)
 Absolute input device axis position changed. More...
 
void analogAbsolute (float value)
 Absolute input device axis position changed. More...
 
void analogRelative (BAAMovement action, float value)
 Relative 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...
 

Public Attributes

ECBehaviorPlayerControllable.Tracker pTracker
 

Protected Member Functions

BAAMovement getMovement ()
 
ECBehaviorPlayerControllable.Tracker getTracker ()
 

Detailed Description

Base class operating only on actors with BAAMovement action.

Member Function Documentation

◆ analogAbsolute() [1/2]

void Dragengine.Commands.CommandsBAAMovement.Base.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 in Dragengine.Commands.CommandsBAAMovement.AnalogLookUD, Dragengine.Commands.CommandsBAAMovement.AnalogLookLR, Dragengine.Commands.CommandsBAAMovement.AnalogMoveLR, and Dragengine.Commands.CommandsBAAMovement.AnalogMoveFB.

◆ analogAbsolute() [2/2]

void Dragengine.Commands.CommandsBAAMovement.Base.analogAbsolute ( 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.Command.

◆ analogRelative() [1/2]

void Dragengine.Commands.CommandsBAAMovement.Base.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 in Dragengine.Commands.CommandsBAAMovement.AnalogLookUD, Dragengine.Commands.CommandsBAAMovement.AnalogLookLR, Dragengine.Commands.CommandsBAAMovement.AnalogMoveLR, and Dragengine.Commands.CommandsBAAMovement.AnalogMoveFB.

◆ analogRelative() [2/2]

void Dragengine.Commands.CommandsBAAMovement.Base.analogRelative ( 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.Command.

◆ getMovement()

BAAMovement Dragengine.Commands.CommandsBAAMovement.Base.getMovement ( )
protected

◆ getTracker()

ECBehaviorPlayerControllable.Tracker Dragengine.Commands.CommandsBAAMovement.Base.getTracker ( )
protected

◆ new()

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

◆ start() [1/2]

void Dragengine.Commands.CommandsBAAMovement.Base.start ( )

Input device key or button has been pressed.

Reimplemented from Dragengine.Commands.Command.

◆ start() [2/2]

◆ stop() [1/2]

void Dragengine.Commands.CommandsBAAMovement.Base.stop ( )

Input device key or button has been released.

Reimplemented from Dragengine.Commands.Command.

◆ stop() [2/2]

Member Data Documentation

◆ pTracker

ECBehaviorPlayerControllable.Tracker Dragengine.Commands.CommandsBAAMovement.Base.pTracker

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