Planeshift
Public Member Functions | Protected Attributes

psActionTimeoutGameEvent Class Reference

Time out event on interacting with an action item. More...

#include <actionmanager.h>

List of all members.

Public Member Functions

virtual bool IsValid ()
 Return the valid flag.
 psActionTimeoutGameEvent (ActionManager *mgr, const psActionLocation *actionLocation, EID actorEID)
 Constructor.
virtual void Trigger ()
 Abstract event processing function.
 ~psActionTimeoutGameEvent ()
 Destructor.

Protected Attributes

const psActionLocationactionLocation
 The action location.
ActionManageractionManager
 Reference to the action manager.
EID actorEID
 Reference to the actor.
bool valid
 Is this trigger still valid.

Detailed Description

Time out event on interacting with an action item.

This timer is fired when an entity is detected to trigger an action location. It will than regullary check if the entity has left and release the entity from the triggered action location.

Definition at line 64 of file actionmanager.h.


Constructor & Destructor Documentation

psActionTimeoutGameEvent::psActionTimeoutGameEvent ( ActionManager mgr,
const psActionLocation actionLocation,
EID  actorEID 
)

Constructor.

Parameters:
mgrPointer to ActionManager, used for callbacks from Trigger.
actionLocationAction location to guard. actorEID The EID of the actor that is inside the action location.
psActionTimeoutGameEvent::~psActionTimeoutGameEvent ( )

Destructor.


Member Function Documentation

virtual bool psActionTimeoutGameEvent::IsValid ( ) [inline, virtual]

Return the valid flag.

Returns:
The valid flag.

Reimplemented from psGameEvent.

Definition at line 85 of file actionmanager.h.

virtual void psActionTimeoutGameEvent::Trigger ( ) [virtual]

Abstract event processing function.

Implements psGameEvent.


Member Data Documentation

The action location.

Definition at line 95 of file actionmanager.h.

Reference to the action manager.

Definition at line 91 of file actionmanager.h.

Reference to the actor.

Definition at line 94 of file actionmanager.h.

Is this trigger still valid.

Reimplemented from psGameEvent.

Definition at line 92 of file actionmanager.h.


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