| 1 | /* |
|---|
| 2 | * ORXONOX - the hottest 3D action shooter ever to exist |
|---|
| 3 | * > www.orxonox.net < |
|---|
| 4 | * |
|---|
| 5 | * |
|---|
| 6 | * License notice: |
|---|
| 7 | * |
|---|
| 8 | * This program is free software; you can redistribute it and/or |
|---|
| 9 | * modify it under the terms of the GNU General Public License |
|---|
| 10 | * as published by the Free Software Foundation; either version 2 |
|---|
| 11 | * of the License, or (at your option) any later version. |
|---|
| 12 | * |
|---|
| 13 | * This program is distributed in the hope that it will be useful, |
|---|
| 14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
|---|
| 15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|---|
| 16 | * GNU General Public License for more details. |
|---|
| 17 | * |
|---|
| 18 | * You should have received a copy of the GNU General Public License |
|---|
| 19 | * along with this program; if not, write to the Free Software |
|---|
| 20 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
|---|
| 21 | * |
|---|
| 22 | * Author: |
|---|
| 23 | * Damian 'Mozork' Frick |
|---|
| 24 | * Co-authors: |
|---|
| 25 | * ... |
|---|
| 26 | * |
|---|
| 27 | */ |
|---|
| 28 | |
|---|
| 29 | #ifndef _QuestHint_H__ |
|---|
| 30 | #define _QuestHint_H__ |
|---|
| 31 | |
|---|
| 32 | #include <map> |
|---|
| 33 | #include <string> |
|---|
| 34 | |
|---|
| 35 | #include "QuestDescription.h" |
|---|
| 36 | #include "QuestItem.h" |
|---|
| 37 | |
|---|
| 38 | namespace questHintStatus |
|---|
| 39 | { |
|---|
| 40 | |
|---|
| 41 | enum Enum |
|---|
| 42 | { |
|---|
| 43 | inactive, |
|---|
| 44 | active |
|---|
| 45 | }; |
|---|
| 46 | |
|---|
| 47 | } |
|---|
| 48 | |
|---|
| 49 | namespace orxonox |
|---|
| 50 | { |
|---|
| 51 | |
|---|
| 52 | class Player; //Forward declaration, remove when fully integrated into the objecthirarchy. |
|---|
| 53 | class Quest; //To avoid circual includes. |
|---|
| 54 | |
|---|
| 55 | /** |
|---|
| 56 | @brief |
|---|
| 57 | Represents a hint in the game towards completing a Quest. |
|---|
| 58 | Consists of title and description in textual form. |
|---|
| 59 | @author |
|---|
| 60 | Damian 'Mozork' Frick |
|---|
| 61 | */ |
|---|
| 62 | class QuestHint : public QuestItem |
|---|
| 63 | { |
|---|
| 64 | |
|---|
| 65 | public: |
|---|
| 66 | QuestHint(); |
|---|
| 67 | QuestHint(std::string id, std::string title = "", std::string description = ""); |
|---|
| 68 | ~QuestHint(); |
|---|
| 69 | |
|---|
| 70 | bool isActive(Player* player); //!< Returns true if the hint is active for the input player. |
|---|
| 71 | |
|---|
| 72 | bool activate(Player* player); //!< Activates the hint for the input player. |
|---|
| 73 | |
|---|
| 74 | void setQuest(Quest* quest); //!< Sets the quest the hint belongs to. |
|---|
| 75 | |
|---|
| 76 | private: |
|---|
| 77 | |
|---|
| 78 | Quest* quest_; |
|---|
| 79 | std::map<Player*, questHintStatus::Enum> playerStatus_; |
|---|
| 80 | |
|---|
| 81 | }; |
|---|
| 82 | |
|---|
| 83 | } |
|---|
| 84 | |
|---|
| 85 | #endif /* _QuestHint_H__ */ |
|---|
