Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/orxonox/objects/quest/AddReward.h @ 3014

Last change on this file since 3014 was 2911, checked in by landauf, 16 years ago

Merged r1-2096 of questsystem5 back to trunk

I hope there weren't more "hidden merge changes" in r2909 than the one in OverlayGroup (removeElement) (and related to this the adjustments in NotificationQueue).

The corresponding media commit seems not yet to be done, but it doesn't break the build.

File size: 2.6 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*/
33
34#ifndef _AddReward_H__
35#define _AddReward_H__
36
37#include "OrxonoxPrereqs.h"
38
39#include <list>
40
41#include "core/XMLPort.h"
42#include "QuestEffect.h"
43
44namespace orxonox
45{
46    /**
47    @brief
48        Adds a list of Rewardables to a player.
49       
50        Creating a AddReward through XML goes as follows:
51       
52        <AddReward>
53            <Rewardable /> //A list of Rewardable objects to be rewarded the player, see the specific Rewardables for their respective XML representations.
54            ...
55            <Rewardable />
56        </AddReward>
57    @author
58        Damian 'Mozork' Frick
59    */
60    class _OrxonoxExport 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.