psquest.h

Go to the documentation of this file.

/*
 * psquest.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 __PSQUEST_H__
#define __PSQUEST_H__
//=============================================================================
// Crystal Space Includes
//=============================================================================
#include <csutil/csstring.h>
#include <csutil/weakreferenced.h>

//=============================================================================
// Project Includes
//=============================================================================
#include <idal.h>

//=============================================================================
// Local Includes
//=============================================================================

using namespace CS;


#define QUEST_OPT_SAVEONCOMPLETE 0x01

#define PSQUEST_DISABLED_QUEST 0x00000001


class psQuestPrereqOp;
class psCharacter;
class NpcResponse;
class NpcTrigger;
class NpcDialogMenu;
class psQuest;

bool LoadPrerequisiteXML(csRef<psQuestPrereqOp> &prerequisite, psQuest* self, csString script);

class psQuest : public CS::Utility::WeakReferenced
{
public:
    psQuest(int id = 0, const char* name = "");
    virtual ~psQuest();

    bool Load(iResultRow &row);
    bool PostLoad();
    
    int GetID() const
    {
        return id;
    }
    const char* GetName() const
    {
        return name;
    }
    const char* GetImage() const
    {
        return image;
    }
    const char* GetTask() const
    {
        return task;
    }

    bool hasTaskText()
    {
        return task.Length() > 0;
    }
    void SetTask(csString mytask)
    {
        task = mytask;
    }
    psQuest* GetParentQuest() const
    {
        return parent_quest;
    }
    void SetParentQuest(psQuest* parent)
    {
        parent_quest=parent;
    }
    int GetStep() const
    {
        return step_id;
    }
    bool HasInfinitePlayerLockout() const
    {
        return infinitePlayerLockout;
    }
    unsigned int GetPlayerLockoutTime() const
    {
        return player_lockout_time;
    }
    unsigned int GetQuestLockoutTime() const
    {
        return quest_lockout_time;
    }
    unsigned int GetQuestLastActivatedTime() const
    {
        return quest_last_activated;
    }
    void SetQuestLastActivatedTime(unsigned int when)
    {
        quest_last_activated=when;
    }
    // csString QuestToXML() const;
    bool AddPrerequisite(csString prerequisitescript);
    bool AddPrerequisite(csRef<psQuestPrereqOp> op);
    
    void AddTriggerResponse(NpcTrigger* trigger, NpcResponse* response);
    //void AddMenu(NpcDialogMenu* menu);
    
    //csArray<NpcDialogMenu*> &GetMenuList();
    
    void AddSubQuest(int id)
    {
        subquests.Push(id);
    }

    csArray<int> &GetSubQuests()
    {
        return subquests;
    }

    csRef<psQuestPrereqOp>& GetPrerequisite()
    {
        return prerequisite;
    }
    csString GetPrerequisiteStr();
    const csString &GetCategory() const
    {
        return category;
    }

    bool Active()
    {
        return active ? (parent_quest ? parent_quest->Active() : active) : active;
    }

    void Active(bool state)
    {
        active = state;
    }

protected:
    int id;             
    csString name;      
    csString task;      
    csString image;
    int flags;
    psQuest* parent_quest;      
    int step_id;                
    csRef<psQuestPrereqOp> prerequisite;
    csString category;
    csString prerequisiteStr;
    bool infinitePlayerLockout;

    unsigned int player_lockout_time;
    unsigned int quest_lockout_time;
    unsigned int quest_last_activated;

    struct TriggerResponse
    {
        NpcTrigger* trigger;
        int responseID;
    };

    // this stuff is needed for cleanup when destroying the object
    csArray<TriggerResponse> triggerPairs; 
    csArray<int> subquests;             

    bool active;
};

#endif