Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/modules/questsystem/effects/AddQuestHint.h @ 11881

Last change on this file since 11881 was 11071, checked in by landauf, 9 years ago

merged branch cpp11_v3 back to trunk

  • Property svn:eol-style set to native
File size: 2.5 KB
RevLine 
[7311]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/**
[7456]30    @file AddQuestHint.h
[7311]31    @brief Definition of the AddQuestHint class.
[7456]32    @ingroup QuestEffects
[7311]33*/
34
35#ifndef _AddQuestHint_H__
36#define _AddQuestHint_H__
37
38#include "questsystem/QuestsystemPrereqs.h"
39
40#include <string>
41#include "questsystem/QuestEffect.h"
42
43namespace orxonox
44{
[7552]45
[7311]46    /**
47    @brief
[7456]48        Adds a @ref orxonox::QuestHint "QuestHint", resp. activates the @ref orxonox::QuestHint "QuestHint" of the given id for the player the QuestEffect is invoked on.
[7311]49
50        Creating a AddQuestHint through XML goes as follows:
51        @code
52        <AddQuestHint hintId="id" />  //Where id identifies the QuestHint that should be added.
53        @endcode
[7552]54
[7311]55    @author
56        Damian 'Mozork' Frick
[7552]57
58    @ingroup QuestEffects
[7311]59    */
60    class _QuestsystemExport AddQuestHint : public QuestEffect
61    {
62        public:
[9667]63            AddQuestHint(Context* context);
[7311]64            virtual ~AddQuestHint();
65
[11071]66            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode) override; //!< Method for creating a AddQuestHint object through XML.
[7311]67
[11071]68            virtual bool invoke(PlayerInfo* player) override; //!< Invokes the QuestEffect.
[7311]69
70        private:
71            std::string hintId_; //!< The id of the QuestHint.
72
73            /**
74            @brief Returns the id of the QuestHint.
75            @return Returns the id of the QuestHint.
76            */
77            inline const std::string & getHintId(void) const
78                { return this->hintId_; }
79
80            bool setHintId(const std::string & id); //!< Sets the id of the QuestHint.
81
82    };
83
84}
85
86#endif /* _AddQuestHint_H__ */
Note: See TracBrowser for help on using the repository browser.