Odyssey::TimedInputCombo Class Reference

This is the timed input combo, using order and timings. More...

#include <InputCombo.h>

Inheritance diagram for Odyssey::TimedInputCombo:

Odyssey::InputCombo List of all members.

Public Member Functions

 TimedInputCombo ()
void setActionTiming (size_t index, const String &action, float32 timing)
 Set the timing and action name parameters for the indexed combo element.
void removeActionTiming (size_t index, bool shrink=true)
 Remove the indexed combo timing element.
const StringgetAction (size_t index) const
 Retrieves the action name assigned to the indexed combo timing element.
float32 getActionTiming (size_t index) const
 Gets the timing info for the indexed combo element.
void reset ()
 Resets the internal combo memory.
void onEvent (const String &action)
 The callback for this combo's action mapping.

Static Public Attributes

static const float32 TIMING_INFINITE

Detailed Description

This is the timed input combo, using order and timings.

This acts as a timed combo. It works by using ordering and timings to invoke the combo. That is, the actions must come in the right order, and within the specified time (between actions) for the combo to get invoked.


Constructor & Destructor Documentation

Odyssey::TimedInputCombo::TimedInputCombo  ) 
 


Member Function Documentation

const String& Odyssey::TimedInputCombo::getAction size_t  index  )  const
 

Retrieves the action name assigned to the indexed combo timing element.

float32 Odyssey::TimedInputCombo::getActionTiming size_t  index  )  const
 

Gets the timing info for the indexed combo element.

void Odyssey::TimedInputCombo::onEvent const String action  )  [virtual]
 

The callback for this combo's action mapping.

This is the callable target that get notified when an action from this combo's action map is invoked. It is in this overrideable that the logic for combo invocation is made. If the combo should be invoked, onCombo needs to be called.

Parameters:
action the name of the action invoked
See also:
onCombo

Reimplemented from Odyssey::InputCombo.

void Odyssey::TimedInputCombo::removeActionTiming size_t  index,
bool  shrink = true
 

Remove the indexed combo timing element.

void Odyssey::TimedInputCombo::reset  ) 
 

Resets the internal combo memory.

void Odyssey::TimedInputCombo::setActionTiming size_t  index,
const String action,
float32  timing
 

Set the timing and action name parameters for the indexed combo element.


Member Data Documentation

const float32 Odyssey::TimedInputCombo::TIMING_INFINITE [static]
 


The documentation for this class was generated from the following file:
Generated on Sun Jan 7 01:18:52 2007 for Odyssey Meta-Engine by  doxygen 1.4.6-NO