Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/kicklib/src/modules/notifications/NotificationDispatcher.cc @ 7957

Last change on this file since 7957 was 7552, checked in by dafrick, 14 years ago

Resolving some TODOs and doing some additional cleanup. Almost done now…

  • Property svn:eol-style set to native
File size: 5.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 thes
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 NotificationDispatcher.cc
31    @brief Implementation of the NotificationDispatcher class.
32*/
33
34#include "NotificationDispatcher.h"
35
36#include "core/CoreIncludes.h"
37#include "core/EventIncludes.h"
38#include "core/XMLPort.h"
39#include "network/NetworkFunction.h"
40#include "network/Host.h"
41
42#include "infos/PlayerInfo.h"
43#include "interfaces/PlayerTrigger.h"
44#include "worldentities/pawns/Pawn.h"
45
46#include "NotificationManager.h"
47
48namespace orxonox
49{
50
51    CreateUnloadableFactory(NotificationDispatcher);
52
53    registerMemberNetworkFunction(NotificationDispatcher, dispatch);
54
55    /**
56    @brief
57        Default constructor. Initializes the object.
58    */
59    NotificationDispatcher::NotificationDispatcher(BaseObject* creator) : BaseObject(creator), Synchronisable(creator)
60    {
61        RegisterObject(NotificationDispatcher);
62
63        this->sender_ = NotificationManager::NONE;
64        this->registerVariables();
65    }
66
67    /**
68    @brief
69        Destructor.
70    */
71    NotificationDispatcher::~NotificationDispatcher()
72    {
73
74    }
75
76    /**
77    @brief
78        Method for creating a NotificationDispatcher object through XML.
79    */
80    void NotificationDispatcher::XMLPort(Element& xmlelement, XMLPort::Mode mode)
81    {
82        SUPER(NotificationDispatcher, XMLPort, xmlelement, mode);
83
84        XMLPortParam(NotificationDispatcher, "sender", getSender, setSender, xmlelement, mode);
85       
86        XMLPortEventSink(NotificationDispatcher, BaseObject, "trigger", trigger, xmlelement, mode); //TODO: Change BaseObject to MultiTrigger as soon as MultiTrigger is the base of all triggers.
87    }
88
89    void NotificationDispatcher::XMLEventPort(Element& xmlelement, XMLPort::Mode mode)
90    {
91        SUPER(NotificationDispatcher, XMLEventPort, xmlelement, mode);
92
93        XMLPortEventState(NotificationDispatcher, BaseObject, "trigger", trigger, xmlelement, mode);
94    }
95
96    /**
97    @brief
98        Registers variables for synchronisation.
99    */
100    void NotificationDispatcher::registerVariables(void)
101    {
102        registerVariable(this->sender_, VariableDirection::ToClient);
103    }
104
105    /**
106    @brief
107        Dispatches a Notification with a message supplied by the createNotificationMessage() method, which can be overloaded.
108    @param clientId
109        The id of the client the notification should be dispatched to.
110    */
111    void NotificationDispatcher::dispatch(unsigned int clientId)
112    {
113        if(GameMode::isStandalone() || Host::getPlayerID() == clientId || this->getSyncMode() == 0x0)
114        {
115            const std::string message = this->createNotificationMessage();
116            NotificationManager::sendNotification(message, clientId, this->getSender());
117        }
118        else if(GameMode::isServer())
119        {
120            callMemberNetworkFunction(NotificationDispatcher, dispatch, this->getObjectID(), clientId, clientId);
121        }
122    }
123
124    /**
125    @brief
126        Is called when the NotificationDispatcher is triggered.
127    @param triggered
128        Whether it has been triggered or untriggered. The NotificationDispatcher only reacts to the first kind of events.
129    @param trigger
130        The object that caused the event to be fired.
131    @return
132        Returns true if the NotificationDispatcher was successfully triggered.
133    */
134    bool NotificationDispatcher::trigger(bool triggered, BaseObject* trigger)
135    {
136        if(!triggered || !this->isActive()) // If the NotificationDispatcher is inactive it cannot be executed.
137            return false;
138
139        COUT(4) << "NotificationDispatcher (&" << this << ") triggered." << std::endl;
140
141        PlayerTrigger* pTrigger = orxonox_cast<PlayerTrigger*>(trigger);
142        Pawn* pawn = NULL;
143
144        // If the trigger is a PlayerTrigger.
145        if(pTrigger != NULL)
146        {
147            if(!pTrigger->isForPlayer())  // The PlayerTrigger is not exclusively for Pawns which means we cannot extract one.
148                return false;
149            else
150                pawn = pTrigger->getTriggeringPlayer();
151        }
152        else
153            return false;
154
155        if(pawn == NULL)
156        {
157            COUT(4) << "The NotificationDispatcher was triggered by an entity other than a Pawn. (" << trigger->getIdentifier()->getName() << ")" << std::endl;
158            return false;
159        }
160
161        // Extract the PlayerInfo from the Pawn.
162        PlayerInfo* player = pawn->getPlayer();
163
164        if(player == NULL)
165        {
166            COUT(3) << "The PlayerInfo* is NULL." << std::endl;
167            return false;
168        }
169
170        this->dispatch(player->getClientID());
171
172        return true;
173    }
174
175}
Note: See TracBrowser for help on using the repository browser.