Dragengine.Commands.CommandsBAAMovement.Base Class Reference

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

Inheritance diagram for Dragengine.Commands.CommandsBAAMovement.Base:

Public Member Functions
void	analogAbsolute (BAAMovement action, float value)
	Absolute input device axis position changed.
void	analogAbsolute (float value)
	Absolute input device axis position changed.
void	analogRelative (BAAMovement action, float value)
	Relative input device axis position changed.
void	analogRelative (float value)
	Relative input device axis position changed.
Base	new (ECBehaviorPlayerControllable.Tracker tracker, String name, String description)
void	start ()
	Input device key or button has been pressed.
void	start (BAAMovement action)
	Start command on action.
void	stop ()
	Input device key or button has been released.
void	stop (BAAMovement action)
	Start command on action.
Public Member Functions inherited from Dragengine.Commands.Command
void	approach ()
	User finger approached device button.
String	getDescription ()
	Description.
String	getDisplayName ()
	Display name or null.
String	getName ()
	Unique name.
String	getTranslateDescription ()
	Translation description or null.
String	getTranslateDisplayName ()
	Translation display name or null.
Command	new ()
	Create command.
Command	new (String name, String description)
	Create command.
void	pulse ()
	Convenience method calling start() and stop() in succession.
void	setDescription (String description)
	Set description.
void	setDisplayName (String displayName)
	Set display name or null.
void	setName (String name)
	Set unique name of the command.
void	setTranslateDescription (String translateName)
	Set translate description or null.
void	setTranslateDisplayName (String translateName)
	Set translate display name or null.
void	touch ()
	Input device button has been touched.
String	translateDescription ()
	Translated command description using default TranslationManager.
String	translateDescription (TranslationManager translationManager)
	Translated command description.
String	translateDisplayName ()
	Translated display name using default TranslationManager.
String	translateDisplayName (TranslationManager translationManager)
	Translated display name.
void	untouch ()
	Input device button has been untouched.
void	withdraw ()
	User finger withdrew from device button.

Public Attributes
ECBehaviorPlayerControllable.Tracker	pTracker
Public Attributes inherited from Dragengine.Commands.Command
String	pName

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

value

New axis position in the range -1 to 1.

Reimplemented in Dragengine.Commands.CommandsBAAMovement.AnalogMoveFB, Dragengine.Commands.CommandsBAAMovement.AnalogMoveLR, Dragengine.Commands.CommandsBAAMovement.AnalogLookLR, and Dragengine.Commands.CommandsBAAMovement.AnalogLookUD.

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

value

New 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

value

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

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

value

Relative 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]

void Dragengine.Commands.CommandsBAAMovement.Base.start

(

BAAMovement

action

)

Start command on action.

Reimplemented in Dragengine.Commands.CommandsBAAMovement.MoveForward, Dragengine.Commands.CommandsBAAMovement.MoveBackward, Dragengine.Commands.CommandsBAAMovement.MoveLeft, Dragengine.Commands.CommandsBAAMovement.MoveRight, Dragengine.Commands.CommandsBAAMovement.LookLeft, Dragengine.Commands.CommandsBAAMovement.LookRight, Dragengine.Commands.CommandsBAAMovement.LookUp, Dragengine.Commands.CommandsBAAMovement.LookDown, Dragengine.Commands.CommandsBAAMovement.Crouch, Dragengine.Commands.CommandsBAAMovement.ToggleCrouch, Dragengine.Commands.CommandsBAAMovement.Run, and Dragengine.Commands.CommandsBAAMovement.ToggleRun.

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]

void Dragengine.Commands.CommandsBAAMovement.Base.stop

(

BAAMovement

action

)

Start command on action.

Reimplemented in Dragengine.Commands.CommandsBAAMovement.MoveForward, Dragengine.Commands.CommandsBAAMovement.MoveBackward, Dragengine.Commands.CommandsBAAMovement.MoveLeft, Dragengine.Commands.CommandsBAAMovement.MoveRight, Dragengine.Commands.CommandsBAAMovement.LookLeft, Dragengine.Commands.CommandsBAAMovement.LookRight, Dragengine.Commands.CommandsBAAMovement.LookUp, Dragengine.Commands.CommandsBAAMovement.LookDown, Dragengine.Commands.CommandsBAAMovement.Crouch, and Dragengine.Commands.CommandsBAAMovement.Run.

Member Data Documentation

pTracker

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

---

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

• CommandsBAAMovement.ds