Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/output/src/libraries/network/NetworkChatListener.h @ 8829

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

enhanced chat system. chat related code is now separated into network-side code (located in Host, Client, Server) and client-side code (located in ChatManager).
note that there are now two chat related listeners: NetworkChatListener, which is used to send chat from the network to ChatManager, and ChatListener, which is used to send online and offline chat from ChatManager to the actual chat interfaces (ChatOverlay, ChatInputHandler, …).
the "chat" console command now supports a second argument which is the clientID of the receiver. this allows private messages (or gameplay messages directed to only one specific player).

  • Property svn:eol-style set to native
File size: 2.0 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 _NetworkChatListener_H__
30#define _NetworkChatListener_H__
31
32#include "NetworkPrereqs.h"
33
34namespace orxonox
35{
36    /**
37        @brief The only function of this interface, incomingChat(), gets called whenever a chat
38        message was received through the network.
39
40        This interface exists mostly to resolve circular dependencies between the chat functions
41        in Host and ChatManager. ChatManager is the main derivative of this interface.
42    */
43    class _NetworkExport NetworkChatListener : virtual public OrxonoxClass
44    {
45        friend class Host;
46
47        public:
48            NetworkChatListener(); // implemented in Host.cc
49            virtual ~NetworkChatListener() {}
50
51        protected:
52            /**
53                @brief Gets called when a chat message was received through the network.
54                @param message The message
55                @param sourceID The (network) client ID of the sender
56            */
57            virtual void incomingChat(const std::string& message, unsigned int sourceID) = 0;
58    };
59}
60
61#endif /* _NetworkChatListener_H__ */
Note: See TracBrowser for help on using the repository browser.