Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/gamecontent/src/libraries/core/Event.cc @ 8953

Last change on this file since 8953 was 8858, checked in by landauf, 13 years ago

merged output branch back to trunk.

Changes:

  • you have to include util/Output.h instead of util/Debug.h
  • COUT(x) is now called orxout(level)
  • output levels are now defined by an enum instead of numbers. see util/Output.h for the definition
  • it's possible to use output contexts with orxout(level, context). see util/Output.h for some common contexts. you can define more contexts
  • you must use 'endl' at the end of an output message, '\n' does not flush the message

Output levels:

  • instead of COUT(0) use orxout()
  • instead of COUT(1) use orxout(user_error) or orxout(internal_error)
  • instead of COUT(2) use orxout(user_warning) or orxout(internal_warning)
  • instead of COUT(3) use orxout(user_status/user_info) or orxout(internal_status/internal_info)
  • instead of COUT(4) use orxout(verbose)
  • instead of COUT(5) use orxout(verbose_more)
  • instead of COUT(6) use orxout(verbose_ultra)

Guidelines:

  • user_* levels are for the user, visible in the console and the log-file
  • internal_* levels are for developers, visible in the log-file
  • verbose_* levels are for debugging, only visible if the context of the output is activated

Usage in C++:

  • orxout() << "message" << endl;
  • orxout(level) << "message" << endl;
  • orxout(level, context) << "message" << endl;

Usage in Lua:

  • orxout("message")
  • orxout(orxonox.level.levelname, "message")
  • orxout(orxonox.level.levelname, "context", "message")

Usage in Tcl (and in the in-game-console):

  • orxout levelname message
  • orxout_context levelname context message
  • shortcuts: log message, error message, warning message, status message, info message, debug message
  • Property svn:eol-style set to native
File size: 4.4 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
31    @brief Implementation of the classes Event and EventState.
32*/
33
34#include "Event.h"
35
36#include "BaseObject.h"
37#include "Identifier.h"
38
39namespace orxonox
40{
41    /**
42        @brief Processes an event (calls the set-function if the necessary conditions are met).
43
44        @param event     The fired event
45        @param object    The object whose state is affected by the event (only needed for debug output)
46    */
47    void EventState::process(const Event& event, BaseObject* object)
48    {
49        if (this->bProcessingEvent_)
50        {
51            orxout(internal_warning, context::events) << "Detected Event loop in section \"" << event.statename_ << "\" of object \"" << object->getName() << "\" and fired by \"" << event.originator_->getName() << '"' << endl;
52            return;
53        }
54
55        this->bProcessingEvent_ = true;
56
57        orxout(verbose, context::events) << "Processing event (EventState) : originator: " << event.originator_->getIdentifier()->getName() << " (&" << event.originator_ << "), activate: " << event.activate_ << ", name: " << event.name_ << ", statename: " << event.statename_ << ", object: " << object->getIdentifier()->getName() << " (&" << object << ")" << "." << endl;
58
59        // check if the originator is an instance of the requested class
60        if (event.originator_->isA(this->subclass_))
61        {
62            // If the EventState doesn't act as an EventSink.
63            // actualize the activationcounter
64            if(!this->bSink_)
65            {
66                if (event.activate_)
67                    ++this->activeEvents_;
68                else
69                {
70                    --this->activeEvents_;
71
72                    if (this->activeEvents_ < 0)
73                        this->activeEvents_ = 0;
74                }
75            }
76
77            if (this->statefunction_->getParamCount() == 0 && event.activate_)
78            {
79                // if the eventfunction doesn't have a state, just call it whenever an activation-event comes in
80                (*this->statefunction_)();
81            }
82            else if (this->bSink_ || (!this->bSink_ && ((this->activeEvents_ == 1 && event.activate_) || (this->activeEvents_ == 0 && !event.activate_)) ) )
83            {
84                // if the eventfunction needs a state, we just call the function if the state changed from 0 to 1 (state = true) or from 1 to 0 (state = false) [but not if activeEvents_ is > 1]
85                if (this->statefunction_->getParamCount() == 1)
86                {
87                    // one argument: just the eventstate
88                    (*this->statefunction_)(event.activate_);
89                }
90                else if (this->statefunction_->getParamCount() >= 2)
91                {
92                    // two arguments: the eventstate and the originator
93                    if (this->subclass_->isExactlyA(ClassIdentifier<BaseObject>::getIdentifier()))
94                    {
95                        // if the subclass is BaseObject, we don't have to cast the pointer
96                        (*this->statefunction_)(event.activate_, event.originator_);
97                    }
98                    else
99                    {
100                        // else cast the pointer to the desired class
101                        void* castOriginator = event.originator_->getDerivedPointer(this->subclass_->getClassID());
102                        (*this->statefunction_)(event.activate_, castOriginator);
103                    }
104                }
105            }
106        }
107
108        this->bProcessingEvent_ = false;
109    }
110}
Note: See TracBrowser for help on using the repository browser.