Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/modules/questsystem/effects/AddReward.cc @ 7552

Last change on this file since 7552 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: 3.0 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.cc
31    @brief Implementation of the AddReward class.
32*/
33
34#include "AddReward.h"
35
36#include "core/CoreIncludes.h"
37#include "core/XMLPort.h"
38
39#include "interfaces/Rewardable.h"
40
41namespace orxonox
42{
43    CreateFactory(AddReward);
44
45    /**
46    @brief
47        Constructor. Registers the object.
48    */
49    AddReward::AddReward(BaseObject* creator) : QuestEffect(creator)
50    {
51        RegisterObject(AddReward);
52    }
53
54    /**
55    @brief
56        Destructor.
57    */
58    AddReward::~AddReward()
59    {
60
61    }
62
63    /**
64        Method for creating a AddReward object through XML.
65    */
66    void AddReward::XMLPort(Element& xmlelement, XMLPort::Mode mode)
67    {
68        SUPER(AddReward, XMLPort, xmlelement, mode);
69
70        XMLPortObject(AddReward, Rewardable, "", addRewardable, getRewardables, xmlelement, mode);
71
72        COUT(4) << "New AddReward, with " << this->rewards_.size() << " Rewardables created." << std::endl;
73    }
74
75    /**
76    @brief
77        Returns the Rewardable object at the given index.
78    @param index
79        The index.
80    @return
81        Returns a pointer to the Rewardable object at the given index.
82    */
83    const Rewardable* AddReward::getRewardables(unsigned int index) const
84    {
85        int i = index;
86        for (std::list<Rewardable*>::const_iterator reward = this->rewards_.begin(); reward != this->rewards_.end(); ++reward)
87        {
88            if(i == 0)
89               return *reward;
90            i--;
91        }
92        return NULL;
93    }
94
95    /**
96    @brief
97        Invokes the QuestEffect.
98    @param player
99        The player.
100    @return
101        Returns true if the QuestEffect was invoked successfully.
102    */
103    bool AddReward::invoke(PlayerInfo* player)
104    {
105        COUT(5) << "AddReward on player: " << player << " ." << std::endl;
106
107        bool check = true;
108        for ( std::list<Rewardable*>::iterator reward = this->rewards_.begin(); reward != this->rewards_.end(); ++reward )
109            check = check && (*reward)->reward(player);
110
111        COUT(4) << "Rewardable successfully added to player." << player << " ." << std::endl;
112
113        return check;
114    }
115
116}
Note: See TracBrowser for help on using the repository browser.