Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/questsystem2/src/orxonox/objects/quest/AddReward.cc @ 2159

Last change on this file since 2159 was 2159, checked in by dafrick, 15 years ago

Completed documentation of finished classes.

File size: 2.8 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
32        Implementation of the AddReward class.
33*/
34
35#include "OrxonoxStableHeaders.h"
36#include "AddReward.h"
37
38#include "core/CoreIncludes.h"
39
40#include "orxonox/objects/worldentities/ControllableEntity.h"
41#include "Rewardable.h"
42
43namespace orxonox {
44
45    CreateFactory(AddReward);
46
47    /**
48    @brief
49        Constructor. Registers the object.
50    */
51    AddReward::AddReward(BaseObject* creator) : QuestEffect(creator)
52    {
53        RegisterObject(AddReward);
54    }
55
56    /**
57    @brief
58        Destructor.
59    */
60    AddReward::~AddReward()
61    {
62    }
63
64    /**
65        Method for creating a AddReward object through XML.
66    */
67    void AddReward::XMLPort(Element& xmlelement, XMLPort::Mode mode)
68    {
69        SUPER(AddReward, XMLPort, xmlelement, mode);
70
71        XMLPortObject(AddReward, Rewardable, "", addRewardable, getRewardables, xmlelement, mode);
72
73    }
74
75    /**
76    @brief
77        Returns the rewardbale 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            {
90               return *reward;
91            }
92            i--;
93        }
94        return NULL;
95    }
96
97    /**
98    @brief
99        Invokes the effect.
100    @param player
101        The player.
102    @return
103        Returns true if the effect was invoked successfully.
104    */
105    bool AddReward::invoke(ControllableEntity* player)
106    {
107        bool check = true;
108        for ( std::list<Rewardable*>::iterator reward = this->rewards_.begin(); reward != this->rewards_.end(); ++reward )
109        {
110            check = check && (*reward)->reward(player);
111        }
112
113        return check;
114    }
115
116}
Note: See TracBrowser for help on using the repository browser.