Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/formation/src/orxonox/chat/ChatManager.cc @ 8948

Last change on this file since 8948 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.1 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#include "ChatManager.h"
30#include "ChatListener.h"
31
32#include "util/ScopedSingletonManager.h"
33#include "core/CoreIncludes.h"
34#include "core/command/ConsoleCommand.h"
35#include "network/Host.h"
36
37#include "PlayerManager.h"
38#include "infos/PlayerInfo.h"
39
40namespace orxonox
41{
42    ManageScopedSingleton(ChatManager, ScopeID::Root, false);
43
44    SetConsoleCommand("chat", &ChatManager::chat).defaultValue(1, NETWORK_PEER_ID_BROADCAST);
45
46    ChatManager::ChatManager()
47    {
48        RegisterObject(ChatManager);
49    }
50
51    /**
52        @brief Sends a message (usually gameplay related) without explicit sender to the chat.
53        @param message The message
54        @param targetID The client ID (network) of the receiver. Usually the broadcast ID
55    */
56    /*static*/ void ChatManager::message(const std::string& message, unsigned int targetID)
57    {
58        unsigned int sourceID = NETWORK_PEER_ID_UNKNOWN;
59
60        // only the server should send gameplay messages through the network. otherwise display the message locally
61        if (GameMode::isServer())
62            Host::sendChat(message, sourceID, targetID);
63        else
64            ChatManager::getInstance().incomingChat(message, sourceID);
65    }
66
67    /**
68        @brief Sends a chat message with the client as its sender to the chat.
69        @param message The message
70        @param targetID The client ID (network) of the receiver. Usually the broadcast ID
71    */
72    /*static*/ void ChatManager::chat(const std::string& message, unsigned int targetID)
73    {
74        unsigned int sourceID = Host::getPlayerID();
75
76        // if connected to the network, send chat messages online. otherwise display chat locally
77        if (GameMode::isServer() || GameMode::isClient())
78            Host::sendChat(message, sourceID, targetID);
79        else
80            ChatManager::getInstance().incomingChat(message, sourceID);
81    }
82
83    /**
84        @brief Inherited callback from NetworkChatListener, but gets also called directly
85        by ChatManager itself if the client is offline. Distributes an incoming chat message
86        to all ChatListeners.
87        @param message The message
88        @param sourceID The client ID (network) of the sender
89    */
90    void ChatManager::incomingChat(const std::string& message, unsigned int sourceID)
91    {
92        std::string text = message;
93        std::string name;
94
95        // get the name of the sender and prepend it to the text message
96        if (sourceID != NETWORK_PEER_ID_UNKNOWN)
97        {
98            PlayerInfo* player = PlayerManager::getInstance().getClient(sourceID);
99            if (player)
100            {
101                name = player->getName();
102                text = name + ": " + message;
103            }
104        }
105
106        // notify all listeners
107        for (ObjectList<ChatListener>::iterator it = ObjectList<ChatListener>::begin(); it != ObjectList<ChatListener>::end(); ++it)
108            it->incomingChat(text, name);
109    }
110
111
112    //////////////////////////////////////////////////////////////////////////
113    // ChatListener                                                         //
114    //////////////////////////////////////////////////////////////////////////
115
116    ChatListener::ChatListener()
117    {
118        RegisterRootObject(ChatListener);
119    }
120}
Note: See TracBrowser for help on using the repository browser.