Planeshift
Public Member Functions

psEndSongEvent Class Reference

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

#include <serversongmngr.h>

List of all members.

Public Member Functions

virtual bool CheckTrigger ()
 Called right before a Trigger is called.
 psEndSongEvent (gemActor *charActor, int songLength)
 Constructor.
virtual void Trigger ()
 Abstract event processing function.
virtual ~psEndSongEvent ()
 Destructor.

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:
charActorthe player that plays this song.
songLengththe length of the song in milliseconds.
virtual psEndSongEvent::~psEndSongEvent ( ) [virtual]

Destructor.


Member Function Documentation

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: