Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/console/src/libraries/core/Event.h @ 6104

Last change on this file since 6104 was 5929, checked in by rgrieder, 15 years ago

Merged core5 branch back to the trunk.
Key features include clean level unloading and an extended XML event system.

Two important notes:
Delete your keybindings.ini files! * or you will still get parser errors when loading the key bindings.
Delete build_dir/lib/modules/libgamestates.module! * or orxonox won't start.
Best thing to do is to delete the build folder ;)

  • Property svn:eol-style set to native
File size: 3.5 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#ifndef _Event_H__
30#define _Event_H__
31
32#include "CorePrereqs.h"
33#include <string>
34
35namespace orxonox
36{
37    /**
38        @brief The Event struct contains information about a fired Event.
39    */
40    struct _CoreExport Event
41    {
42        Event(bool activate, BaseObject* originator, const std::string& name) : activate_(activate), originator_(originator), name_(name) {}
43
44        bool        activate_;   //!< True if this is an activating event (the event source was inactive before and just triggered the event) - false otherwise
45        std::string statename_;  //!< The name of the state this event affects
46        BaseObject* originator_; //!< The object which triggered this event
47        std::string name_;       //!< The name of this event
48    };
49
50    /**
51        @brief The EventState contains information about an event state.
52       
53        An event state is a state of an object, which can be changed by events.
54        Event states are changed through functions. Possible functions headers for set event states are:
55         - memoryless state: function()
56         - boolean state:    function(bool state)
57         - individual state: function(bool state, SomeClass originator)
58         
59        Note that SomeClass may be any class deriving from BaseObject. You will not receive events from originators of other classes.
60        The actual class for SomeClass must be specified as the second argument of the XMLPortEventState macro.
61       
62        The this pointer of the affected object is hidden in the functors, because the events are processed in the BaseObject, but some
63        statefunctions may be from child-classes.
64    */
65    class _CoreExport EventState
66    {
67        public:
68            EventState(Functor* statefunction, Identifier* subclass) : bProcessingEvent_(false), activeEvents_(0), statefunction_(statefunction), subclass_(subclass) {}
69            virtual ~EventState();
70
71            void process(const Event& event, BaseObject* object);
72           
73            Functor* getFunctor() const
74                { return this->statefunction_; }
75
76        private:
77            bool        bProcessingEvent_;  //!< This becomes true while the container processes an event (used to prevent loops)
78            int         activeEvents_;      //!< The number of events which affect this state and are currently active
79            Functor*    statefunction_;     //!< A functor to set the state
80            Identifier* subclass_;          //!< Originators must be an instance of this class (usually BaseObject, but some statefunctions allow a second argument with an originator of a specific class)
81    };
82}
83
84#endif /* _Event_H__ */
Note: See TracBrowser for help on using the repository browser.