git.maemo.org Git - lordsawar/blob - src/QKillHero.h

   1 // Copyright (C) 2003, 2004, 2005 Ulf Lorenz
   2 // Copyright (C) 2004 Andrea Paternesi
   3 // Copyright (C) 2007, 2008, 2009 Ben Asselstine
   4 // Copyright (C) 2008 Ole Laursen
   5 //
   6 //  This program is free software; you can redistribute it and/or modify
   7 //  it under the terms of the GNU General Public License as published by
   8 //  the Free Software Foundation; either version 3 of the License, or
   9 //  (at your option) any later version.
  10 //
  11 //  This program is distributed in the hope that it will be useful,
  12 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 //  GNU Library General Public License for more details.
  15 //
  16 //  You should have received a copy of the GNU General Public License
  17 //  along with this program; if not, write to the Free Software
  18 //  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19 //  02110-1301, USA.
  20
  21 #ifndef QUEST_KILL_HERO_H
  22 #define QUEST_KILL_HERO_H
  23
  24 #include <sigc++/trackable.h>
  25
  26 #include <list>
  27 #include "Quest.h"
  28 #include "hero.h"
  29 #include "playerlist.h"
  30
  31
  32 //! A Quest to kill another Player's Hero.
  33 /**
  34  * A hero that receives this quest has to kill a particular Hero.  The Quest
  35  * is completed when this happens, or the quest is expired if enemy Hero dies.
  36  */
  37 class QuestKillHero : public Quest, public sigc::trackable
  38 {
  39 public:
  40
  41     //! Default constructor.
  42     /**
  43      * Make a new kill-hero quest.
  44      *
  45      * @param q_mgr  The quests manager to associate this quest with.
  46      * @param hero   The Id of the Hero who is responsible for the quest.
  47      */
  48     QuestKillHero(QuestsManager& q_mgr, guint32 hero);
  49
  50     //! Loading constructor.
  51     /**
  52      * @param q_mgr   The quests manager to associate this quest with.
  53      * @param helper  The opened saved-game file to load this quest from.
  54      */
  55     QuestKillHero(QuestsManager& q_mgr, XML_Helper* helper);
  56
  57     // Construct from remote action.
  58     QuestKillHero(QuestsManager& q_mgr, guint32 hero, guint32 victim);
  59
  60
  61     // Get Methods
  62
  63     //! Return a description of how well the quest to kill a hero is going.
  64     std::string getProgress() const;
  65
  66     //! Return a queue of strings to show when the quest is compeleted.
  67     void getSuccessMsg(std::queue<std::string>& msgs) const;
  68
  69     //! Return a queue of strings to show when the quest has expired.
  70     void getExpiredMsg(std::queue<std::string>& msgs) const;
  71
  72     //! Returns the Id of the hunted hero object.
  73     guint32 getVictim() const {return d_victim;}
  74
  75
  76     // Methods that operate on the class data and do not modify the class.
  77
  78     //! Saves the kill-hero quest data to an opened saved-game file.
  79     bool save(XML_Helper* helper) const;
  80
  81
  82     // Methods that need to be implemented from the superclass.
  83
  84     //! Callback for when an Army object is killed.
  85     /**
  86      * This method is used to check when the Hero responsible for the
  87      * quest kills the Hero that is the target of this quest.
  88      *
  89      * @param army           A pointer to the Army object that has been
  90      *                       killed.
  91      * @param heroIsCulprit  Whether or not the Hero object responsible for
  92      *                       this Quest was involved with the killing of
  93      *                       the given Army object.
  94      */
  95     void armyDied(Army *a, bool heroIsCulprit);
  96
  97     //! Callback for when a City is defeated.
  98     /**
  99      * @note This method is not used.
 100      */
 101     void cityAction(City *c, CityDefeatedAction action,
 102                     bool heroIsCulprit, int gold);
 103
 104
 105     // Static Methods
 106
 107     //! Returns whether or not this quest is impossible.
 108     /**
 109      * Checks to see if any Players have a Hero to target.
 110      *
 111      * @param heroId  The Id of the Hero responsible for the kill-hero
 112      *                quest.
 113      *
 114      * @return Whether or not the quest is possible.
 115      */
 116     static bool isFeasible(guint32 heroId);
 117
 118 private:
 119
 120     //! Generate a description of the Quest.
 121     void initDescription();
 122
 123     //! Choose a hero to be killed.
 124     /**
 125      * @return A pointer to the Hero object to be the target for this
 126      *         quest.
 127      */
 128     static Hero* chooseToKill();
 129
 130     //! The Id of the Hero object to be hunted and killed.
 131     guint32 d_victim;
 132 };
 133
 134 #endif