Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/libraries/network/packet/Chat.h @ 11007

Last change on this file since 11007 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: 1.9 KB
RevLine 
[3214]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 *      Oliver Scheuss <scheusso [at] ee.ethz.ch>
24 *   Co-authors:
25 *      ...
26 *
27 */
[1711]28
[3214]29#ifndef _NETWORK_Chat_H__
30#define _NETWORK_Chat_H__
[1701]31
[3214]32#include "network/NetworkPrereqs.h"
[1711]33#include "Packet.h"
[1701]34
[2171]35namespace orxonox {
[1701]36namespace packet {
37/**
[6073]38    @author
[1701]39*/
[2087]40class _NetworkExport Chat : public Packet
[1701]41{
42public:
[7163]43  /* constructors */
[8858]44  Chat( const std::string& message, unsigned int sourceID, unsigned int targetID );
[1907]45  Chat( uint8_t* data, unsigned int clientID );
[7163]46
47  /* destructor */
[1701]48  ~Chat();
[2087]49
[7163]50  /* get size of packet */
[1701]51  inline unsigned int getSize() const;
[7163]52
53  /* process chat message packet and remove it afterwards */
[7801]54  virtual bool process(orxonox::Host* host);
[2087]55
[7163]56  /* Get the length of the message (not the full size of the packet) */
[1701]57  unsigned int getMessageLength(){ return messageLength_; };
[7163]58
59  /* return message content */
[1701]60  unsigned char *getMessage();
[7163]61
[1701]62private:
[7163]63
64  /* Message length */
[1907]65  uint32_t messageLength_;
[7163]66
67  /* Client ID (an integral value for identification) */
[1907]68  unsigned int clientID_;
[1701]69};
70
71} //namespace packet
[2171]72} //namespace orxonox
[1701]73
[3214]74#endif /* _NETWORK_Chat_H__ */
Note: See TracBrowser for help on using the repository browser.