Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/questsystem2/src/orxonox/objects/quest/QuestEffect.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.2 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 QuestEffect.cc
31    @brief
32        Implementation of the QuestEffect class.
33*/
34
35#include "OrxonoxStableHeaders.h"
36#include "QuestEffect.h"
37
38#include "core/CoreIncludes.h"
39
40#include "orxonox/objects/worldentities/ControllableEntity.h"
41
42namespace orxonox {
43
44    /**
45    @brief
46        Constructor. Creates a new QuestEffect.
47        Is not meant to be invoked directly, since this is only an interface.
48    */
49    QuestEffect::QuestEffect(BaseObject* creator) : BaseObject(creator)
50    {
51        RegisterObject(QuestEffect);
52    }
53
54    /**
55    @brief
56        Destructor.
57    */
58    QuestEffect::~QuestEffect()
59    {
60
61    }
62
63    /**
64    @brief
65        Static method. Invoke all effects in an effect list on a given player.
66    @param player
67        The player the effects are invoked on.
68    @param effects
69        A list of all the effects to be invoked.
70    @return
71        Returns false if there was an error, view console of log for further detail.
72    */
73    bool QuestEffect::invokeEffects(ControllableEntity* player, std::list<QuestEffect*> & effects)
74    {
75        bool check = true;
76
77        for (std::list<QuestEffect*>::iterator effect = effects.begin(); effect != effects.end(); effect++)
78        {
79            check = check && (*effect)->invoke(player);
80        }
81        return check;
82    }
83
84}
Note: See TracBrowser for help on using the repository browser.