Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/modules/objects/triggers/EventTrigger.cc @ 11228

Last change on this file since 11228 was 11099, checked in by muemart, 9 years ago

Fix loads of doxygen warnings and other documentation issues

  • Property svn:eol-style set to native
File size: 2.3 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 *      Fabian 'x3n' Landau
24 *   Co-authors:
25 *      ...
26 *
27 */
28
29/**
30    @file EventTrigger.cc
31    @brief Implementation of the EventTrigger class.
32    @ingroup NormalTrigger
33*/
34
35#include "EventTrigger.h"
36
37#include "core/CoreIncludes.h"
38#include "core/EventIncludes.h"
39
40namespace orxonox
41{
42    RegisterClass(EventTrigger);
43
44    /**
45    @brief
46        Constructor. Registers and initializes the object.
47    */
48    EventTrigger::EventTrigger(Context* context) : Trigger(context)
49    {
50        RegisterObject(EventTrigger);
51
52        this->bEventTriggered_ = false;
53    }
54
55    /**
56    @brief
57        Destructor.
58    */
59    EventTrigger::~EventTrigger()
60    {
61    }
62
63    /**
64    @brief
65        Creates an event port.
66    */
67    void EventTrigger::XMLEventPort(Element& xmlelement, XMLPort::Mode mode)
68    {
69        SUPER(EventTrigger, XMLEventPort, xmlelement, mode);
70
71        XMLPortEventState(EventTrigger, BaseObject, "trigger", trigger, xmlelement, mode);
72    }
73
74    /**
75    @brief
76        Check whether the EventTrigger should be triggered.
77        It should be triggered if it is triggered according just to its sub-triggers and if the last event that came in was an event that changed from not triggered to triggered.
78    */
79    bool EventTrigger::isTriggered(TriggerMode mode)
80    {
81        if (Trigger::isTriggered(mode))
82            return this->bEventTriggered_;
83        else
84            return false;
85    }
86}
Note: See TracBrowser for help on using the repository browser.