hoa_map::private_map::SpriteAction Class Reference

An abstract class for sprite actions. More...

#include <map_actions.h>

Inheritance diagram for hoa_map::private_map::SpriteAction:

[legend]Collaboration diagram for hoa_map::private_map::SpriteAction:


Public Member Functions
virtual void	Execute ()=0
	Executes the sprite's action.
const bool	IsFinished ()
	Inidicates if the action is finished or not.
bool	IsFinishedReset ()
	Inidicates if the action is finished or not and resets the finished member if it is.
bool	IsForced () const
	This method returns if this action is forced (true) or not (false). A forced action will have to finish in order to let a dialogue continue to its next line.
void	SetFinished (bool fin)
void	SetForced (bool forc)
void	SetSprite (VirtualSprite *sp)
	SpriteAction (VirtualSprite *sprite)
virtual	~SpriteAction ()
Protected Attributes
bool	_finished
	Set to true when the action has finished its execution.
bool	_forced
	This contains if the action should be forced to finish or not during a dialogue.
VirtualSprite *	_sprite
	A pointer to the map sprite that this action is performed upon.

Detailed Description

An abstract class for sprite actions.

****************************************************************************

Map sprites can perform a variety of different actions, from movement to emotional animation. This class serves as a parent class for the common actions that sprites can take. The children classes are provided as a convenience to the map designer and for code re-usablity. The map script may also create custom actions for sprites to take in addition to the actions provided in this class.

Definition at line 40 of file map_actions.h.

Constructor & Destructor Documentation

hoa_map::private_map::SpriteAction::SpriteAction ( VirtualSprite * sprite ) [inline]

Definition at line 42 of file map_actions.h.

virtual hoa_map::private_map::SpriteAction::~SpriteAction ( ) [inline, virtual]

Definition at line 45 of file map_actions.h.

Member Function Documentation

virtual void hoa_map::private_map::SpriteAction::Execute ( ) [pure virtual]

Executes the sprite's action.

Implemented in hoa_map::private_map::ActionPathMove, hoa_map::private_map::ActionRandomMove, and hoa_map::private_map::ActionAnimate.

const bool hoa_map::private_map::SpriteAction::IsFinished ( ) [inline]

Inidicates if the action is finished or not.

Returns:: True if the action is finished, false if it is not.

Definition at line 54 of file map_actions.h.

References _finished.

bool hoa_map::private_map::SpriteAction::IsFinishedReset ( ) [inline]

Inidicates if the action is finished or not and resets the finished member if it is.

Returns:: True if the action is finished, false if it is not.

Note:: This is not a normal class member act

Definition at line 61 of file map_actions.h.

References _finished.

bool hoa_map::private_map::SpriteAction::IsForced ( ) const [inline]

This method returns if this action is forced (true) or not (false). A forced action will have to finish in order to let a dialogue continue to its next line.

Definition at line 67 of file map_actions.h.

References _forced.

void hoa_map::private_map::SpriteAction::SetFinished ( bool fin ) [inline]

Definition at line 70 of file map_actions.h.

References _finished.

void hoa_map::private_map::SpriteAction::SetForced ( bool forc ) [inline]

Definition at line 73 of file map_actions.h.

References _forced.

void hoa_map::private_map::SpriteAction::SetSprite ( VirtualSprite * sp ) [inline]