questmanager.h

Go to the documentation of this file.

/*
 * questmanager.h
 *
 * Copyright (C) 2003 Atomic Blue (info@planeshift.it, http://www.atomicblue.org)
 *
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation (version 2 of the License)
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 */
#ifndef __QUESTMANAGER_H__
#define __QUESTMANAGER_H__

//=============================================================================
// Crystal Space Includes
//=============================================================================

//=============================================================================
// Project Includes
//=============================================================================
#include "bulkobjects/psquest.h"

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


class Client;
class psItemStats;

struct QuestRewardOffer;
struct QuestRewardItem;
class gemNPC;
class NpcDialogMenu;
class NpcResponse;
class WordArray;
class psString;

class QuestManager : public MessageManager<QuestManager>
{
protected:
    csPDelArray<QuestRewardOffer>  offers;

    csString lastError;     

    CacheManager* cacheManager;

    bool LoadQuestScripts();
    int  PreParseQuestScript(psQuest* mainQuest,const char* script);
    void CutOutParenthesis(csString &response, csString &within,char start_char,char end_char) const;

    bool GetResponseText(csString &block,csString &response,csString &file_path,
                         csString &him, csString &her, csString &it, csString &them) const;
    bool BuildTriggerList(csString &block,csStringArray &list) const;

    bool ParseQuestScriptMenu(const csString &block,const csStringArray &triggers, psQuest* quest, NpcDialogMenu* menu) const;

    int GetNPCFromBlock(WordArray words,csString &current_npc);
    bool ParseItemList(const csString &input, csString &parsedItemList);
    bool ParseItem(const char* text, psStringArray &xmlItems, psMoney &money);

    NpcResponse* AddResponse(const csString &current_npc,const char* response_text,
                             int &last_response_id, psQuest* quest,
                             csString &him, csString &her, csString &it, csString &them, csString &file_path);
    bool         AddTrigger(const csString &current_npc,const char* trigger,
                            int prior_response_id,NpcResponse* trig_response, psQuest* quest, const psString &postfix);
    void         MergeTriggerMenus(NpcDialogMenu* pending_menu, const csString &current_npc);

    void GetNextScriptLine(psString &scr, csString &block, size_t &start, int &line_number);
    bool PrependPrerequisites(csString &substep_requireop,
                              csString &response_requireop,
                              bool quest_assigned_already,
                              NpcResponse* last_response,
                              psQuest* mainQuest);

    bool HandlePlayerAction(csString &block,
                            size_t &which_trigger,
                            csString &current_npc,
                            csStringArray &pending_triggers);

    bool HandleScriptCommand(csString &block,
                             csString &response_requireop,
                             csString &substep_requireop,
                             NpcResponse* last_response,
                             psQuest* mainQuest,
                             bool &quest_assigned_already,
                             psQuest* quest);

    csString ParseRequireCommand(csString &block, bool &result, psQuest* mainQuest);

    bool HandleRequireCommand(csString &block, csString &response_requireop, psQuest* mainQuest);

    void AutocompleteQuestName(csString &questname, psQuest* mainQuest);

    void HandleQuestInfo(MsgEntry* pMsg,Client* client);
    void HandleQuestReward(MsgEntry* pMsg,Client* client);

private:
    class TaskEntry
    {
    public:
        csString text;        
        int completionOrder;  
        int questOrder;       

        bool operator<(const TaskEntry &other) const
        {
            //first check if the completion order is different
            //in that case use that as order
            if(completionOrder != other.completionOrder)
            {
                return completionOrder > other.completionOrder;
            }
            //if they are the same check for the case the completion
            //order is invalid and check if quest order is different
            return questOrder > other.questOrder;
        }
    };

public:

    QuestManager(CacheManager* cachemanager);
    virtual ~QuestManager();

    bool Initialize();

    int  ParseQuestScript(int id,const char* script);

    int  ParseCustomScript(int id, const csString& current_npc, const char* script);

    void Assign(psQuest* quest, Client* who, gemNPC* assigner,csTicks timeDelay=0);

    bool Complete(psQuest* quest, Client* who, csTicks timeDelay = 0);

    bool Uncomplete(psQuest* quest, Client* who, csTicks timeDelay = 0);


    void OfferRewardsToPlayer(Client* who, csArray<QuestRewardItem>& offer, csTicks& timeDelay);
    bool GiveRewardToPlayer(Client* who, QuestRewardItem& reward);
    bool LoadQuestScript(int id);
    const char* LastError()
    {
        return lastError.GetData();
    }
};


#endif