gmeventmanager.h

Go to the documentation of this file.

#ifndef __GMEVENTMANAGER_H__
#define __GMEVENTMANAGER_H__
//=============================================================================
// Crystal Space Includes
//=============================================================================
#include <csutil/ref.h>
#include <csutil/csstring.h>
#include <csutil/array.h>

//=============================================================================
// Project Includes
//=============================================================================

//=============================================================================
// Local Includes
//=============================================================================
#include "msgmanager.h"

#define MAX_PLAYERS_PER_EVENT 100
#define MAX_EVENT_NAME_LENGTH 40
#define MAX_REGISTER_RANGE    100.0
#define EVAL_LOCKOUT_TIME 24*60*60*1000 ///< how much time the player should be allowed to evalute an event (24 hours here)

#define UNDEFINED_GMID        0

#define SUPPORT_GM_LEVEL      GM_LEVEL_4

class psItemStats;
class psRewardData;

enum GMEventStatus
{
    EMPTY = 0,                 
    RUNNING,                   
    COMPLETED                  
};

#define NO_RANGE -1.0

enum RangeSpecifier
{
    ALL,
    IN_RANGE,
    INDIVIDUAL
};

class GMEventManager : public MessageManager<GMEventManager>
{
public:
    GMEventManager();
    ~GMEventManager();

    bool Initialise(void);

    bool AddNewGMEvent(Client* client, csString eventName, csString eventDescription);

    bool RegisterPlayerInGMEvent(Client* client, Client* target);

    bool RegisterPlayersInRangeInGMEvent(Client* client, float range);

    bool CompleteGMEvent(Client* client, PID gmID, bool byTheControllerGM = true);

    bool CompleteGMEvent(Client* client, csString eventName);

    bool ListGMEvents(Client* client);

    bool RemovePlayerFromGMEvent(Client* client, Client* target);

    bool RewardPlayersInGMEvent(Client* client,
                                RangeSpecifier rewardRecipient,
                                float range,
                                Client* target,
                                psRewardData* reward);

    int GetAllGMEventsForPlayer(PID playerID,
                                csArray<int> &completedEvents,
                                int &runningEventAsGM,
                                csArray<int> &completedEventsAsGM);

    GMEventStatus GetGMEventDetailsByID(int id,
                                        csString &name,
                                        csString &description);

    virtual void HandleGMEventCommand(MsgEntry* me, Client* client);

    bool RemovePlayerFromGMEvents(PID playerID);

    bool AssumeControlOfGMEvent(Client* client, csString eventName);

    bool EraseGMEvent(Client* client, csString eventName);

private:

    int nextEventID;

    struct PlayerData
    {
        PID PlayerID; 
        bool CanEvaluate; 
    };

    struct GMEvent
    {
        int id; 
        GMEventStatus status; 
        PID gmID; 
        csTicks EndTime; 
        csString eventName; 
        csString eventDescription; 
        csArray<PlayerData> Player; 
    };
    csArray<GMEvent*> gmEvents;    

    GMEvent* GetGMEventByID(int id);

    GMEvent* GetGMEventByGM(PID gmID, GMEventStatus status, int &startIndex);

    GMEvent* GetGMEventByName(csString eventName, GMEventStatus status, int &startIndex);

    GMEvent* GetGMEventByPlayer(PID playerID, GMEventStatus status, int &startIndex);

    size_t GetPlayerFromEvent(PID &PlayerID, GMEvent* Event);

    bool CheckEvalStatus(PID PlayerID, GMEvent* Event);

    void SetEvalStatus(PID PlayerID, GMEvent* Event, bool NewStatus);

    int GetNextEventID(void);

    void DiscardGMEvent(Client* client, int eventID);

    bool RemovePlayerRefFromGMEvent(GMEvent* gmEvent, Client* client, PID playerID);

    bool EraseGMEvent(Client* client, GMEvent* gmEvent);

    void WriteGMEventEvaluation(Client* client, GMEvent* Event, csString XmlStr);
};

#endif