Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/questsystem2/src/orxonox/objects/quest/AddReward.h @ 2392

Last change on this file since 2392 was 2251, checked in by dafrick, 16 years ago

Some cleanup…

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