Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/masterserver/src/modules/questsystem/effects/AddReward.h @ 7631

Last change on this file since 7631 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.7 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 AddReward.h
31    @brief Definition of the AddReward class.
32    @ingroup QuestEffects
33*/
34
35#ifndef _AddReward_H__
36#define _AddReward_H__
37
38#include "questsystem/QuestsystemPrereqs.h"
39
40#include <list>
41#include "questsystem/QuestEffect.h"
42
43namespace orxonox
44{
45    /**
46    @brief
47        Adds a list of @ref orxonox::Rewardable "Rewardables" to a player.
48
49        Creating a AddReward through XML goes as follows:
50        @code
51        <AddReward>
52            <Rewardable /> //A list of Rewardable objects to be rewarded the player, see the specific Rewardables for their respective XML representations.
53            ...
54            <Rewardable />
55        </AddReward>
56        @endcode
57    @author
58        Damian 'Mozork' Frick
59    */
60    class _QuestsystemExport AddReward : public QuestEffect
61    {
62        public:
63            AddReward(BaseObject* creator);
64            virtual ~AddReward();
65
66            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode); //!< Method for creating a AddReward object through XML.
67
68            virtual bool invoke(PlayerInfo* player); //!< Invokes the QuestEffect.
69
70        private:
71            std::list<Rewardable*> rewards_; //!< A list of Rewardables to be added to the player invoking the QuestEffect.
72
73            /**
74            @brief Add a Rewardable object to the list of objects to be awarded to the player invoking the QuestEffect.
75            @param reward Pointer to the Rewardable to be added.
76            */
77            inline void addRewardable(Rewardable* reward)
78                { this->rewards_.push_back(reward); }
79
80            const Rewardable* getRewardables(unsigned int index) const; //!< Returns the Rewardable object at the given index.
81
82    };
83
84}
85
86#endif /* _AddReward_H__ */
Note: See TracBrowser for help on using the repository browser.