Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/environment/src/modules/questsystem/effects/AddQuestHint.h @ 8236

Last change on this file since 8236 was 7456, checked in by dafrick, 14 years ago

Reviewing documentation fo Questsystem, moving documentation fully into doxygen.
Added some files to modules they belong to.

  • Property svn:eol-style set to native
File size: 2.4 KB
Line 
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/**
30    @file AddQuestHint.h
31    @brief Definition of the AddQuestHint class.
32    @ingroup QuestEffects
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{
45    /**
46    @brief
47        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.
48
49        Creating a AddQuestHint through XML goes as follows:
50        @code
51        <AddQuestHint hintId="id" />  //Where id identifies the QuestHint that should be added.
52        @endcode
53    @author
54        Damian 'Mozork' Frick
55    */
56    class _QuestsystemExport AddQuestHint : public QuestEffect
57    {
58        public:
59            AddQuestHint(BaseObject* creator);
60            virtual ~AddQuestHint();
61
62            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode); //!< Method for creating a AddQuestHint object through XML.
63
64            virtual bool invoke(PlayerInfo* player); //!< Invokes the QuestEffect.
65
66        private:
67            std::string hintId_; //!< The id of the QuestHint.
68
69            /**
70            @brief Returns the id of the QuestHint.
71            @return Returns the id of the QuestHint.
72            */
73            inline const std::string & getHintId(void) const
74                { return this->hintId_; }
75
76            bool setHintId(const std::string & id); //!< Sets the id of the QuestHint.
77
78    };
79
80}
81
82#endif /* _AddQuestHint_H__ */
Note: See TracBrowser for help on using the repository browser.