This event informs the song manager when the song is over. More...

Public Member Functions
virtual bool	CheckTrigger ()
	Called right before a Trigger is called. More...

	psEndSongEvent (gemActor *charActor, int songLength)
	Constructor. More...

virtual void	Trigger ()
	Abstract event processing function. More...

virtual	~psEndSongEvent ()
	Destructor. More...

Public Member Functions inherited from psGameEvent
const char *	GetType ()
	Return the type that this event where created with. More...

virtual bool	IsValid ()
	Return the valid flag. More...

bool	operator< (const psGameEvent &other) const

bool	operator== (const psGameEvent &other) const

bool	operator> (const psGameEvent &other) const

	psGameEvent (csTicks ticks, int offsetticks, const char *newType)
	Construct a new game event. More...

void	QueueEvent ()
	Publish the game event to the local program. More...

virtual void	SetValid (bool valid)
	Set the valid flag. More...

virtual csString	ToString () const
	Return a string with information about the event. More...

virtual	~psGameEvent ()

Additional Inherited Members
Public Attributes inherited from psGameEvent
csTicks	delayticks
	delay before the event starts More...

int	id
	id value combined with ticks ensures uniqueness for tree More...

csTicks	triggerticks
	ticks value when event should be triggered. More...

bool	valid
	Set this to false if the trigger should not be fired. More...

Static Public Attributes inherited from psGameEvent
static EventManager *	eventmanager

static int	nextid
	id counter sequence More...

Detailed Description

This event informs the song manager when the song is over.

Definition at line 46 of file serversongmngr.h.

Constructor & Destructor Documentation

psEndSongEvent::psEndSongEvent	(	gemActor *	charActor,
		int	songLength
	)

Constructor.

Parameters

charActor	the player that plays this song.
songLength	the length of the song in milliseconds.

virtual psEndSongEvent::~psEndSongEvent ( )

virtual

Destructor.

virtual bool psEndSongEvent::CheckTrigger ( )

virtual

Called right before a Trigger is called.

Default implementation use the valid flag to determin if the Trigger should be calle.Could be overridden to allow for other conditions.

This function allows psGEMEvents to disconnect themselves

Reimplemented from psGameEvent.

virtual void psEndSongEvent::Trigger ( )

virtual

Abstract event processing function.

This functino have to be overridden and will be called if CheckTrigger is ok at the time given in the constructor.

Implements psGameEvent.

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