ScummVM API documentation
hpl::iAction Class Referenceabstract
Inheritance diagram for hpl::iAction:
hpl::cActionKeyboard hpl::cActionMouseButton

Public Member Functions

 iAction (tString asName)
 
bool WasTriggerd ()
 
bool BecameTriggerd ()
 
bool DoubleTriggerd (float afLimit)
 
void Update (float afTimeStep)
 
tString GetName ()
 
virtual void UpdateLogic (float afTimeStep)
 
virtual bool IsTriggerd ()=0
 
virtual float GetValue ()=0
 
virtual tString GetInputName ()=0
 
virtual tString GetInputType ()=0
 

Member Function Documentation

◆ WasTriggerd()

bool hpl::iAction::WasTriggerd ( )
Returns
returns true if the action just was triggered, else false

◆ BecameTriggerd()

bool hpl::iAction::BecameTriggerd ( )
Returns
true if the action just became triggered, else false

◆ DoubleTriggerd()

bool hpl::iAction::DoubleTriggerd ( float  afLimit)
Returns
true if the action just was double triggered (double clicked), else false

◆ Update()

void hpl::iAction::Update ( float  afTimeStep)

Update the Action, called by cInput

◆ GetName()

tString hpl::iAction::GetName ( )
Returns
the name of the action.

◆ UpdateLogic()

virtual void hpl::iAction::UpdateLogic ( float  afTimeStep)
virtual

Update special logic for the action. Normally empty

◆ IsTriggerd()

virtual bool hpl::iAction::IsTriggerd ( )
pure virtual

Filled in by the class that inherits from Action.

Returns
true if the action is being triggered

Implemented in hpl::cActionKeyboard, and hpl::cActionMouseButton.

◆ GetValue()

virtual float hpl::iAction::GetValue ( )
pure virtual
Returns
A value from the input, ie the relative mouse x position.

Implemented in hpl::cActionKeyboard, and hpl::cActionMouseButton.

◆ GetInputName()

virtual tString hpl::iAction::GetInputName ( )
pure virtual

The name of the input, ie for keyboard the name of the key is returned.

Implemented in hpl::cActionKeyboard, and hpl::cActionMouseButton.

◆ GetInputType()

virtual tString hpl::iAction::GetInputType ( )
pure virtual

The name of the input type.

Implemented in hpl::cActionKeyboard, and hpl::cActionMouseButton.


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