kgamemessage.h

Go to the documentation of this file.

/*
    This file is part of the KDE games library
    Copyright (C) 2001 Martin Heni (kde at heni-online.de)
    Copyright (C) 2001 Andreas Beckermann (b_mann@gmx.de)

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License version 2 as published by the Free Software Foundation.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/

#ifndef __KGAMEMESSAGE_H_
#define __KGAMEMESSAGE_H_

#include <QtCore/QDataStream>
#include "../libkdegamesprivate_export.h"

class KDEGAMESPRIVATE_EXPORT KGameMessage
{
  public:
    static quint32 createPlayerId(int player, quint32 game);

    static int rawPlayerId(quint32 playerid);

    static quint32 rawGameId(quint32 playerid);

    static bool isPlayer(quint32 id);

    static bool isGame(quint32 id);

    static void createHeader(QDataStream &msg, quint32 sender, quint32 receiver, int msgid);

    static void extractHeader(QDataStream &msg,quint32 &sender, quint32 &receiver, int &msgid);

    static void createPropertyHeader(QDataStream &msg, int id);

    static void extractPropertyHeader(QDataStream &msg, int &id);

    static void createPropertyCommand(QDataStream &msg, int cmdid, int pid, int cmd);

    static void extractPropertyCommand(QDataStream &msg, int &pid, int &cmd);

    static int version();

    static QString messageId2Text(int msgid);


// please document every new id with a short comment
  enum GameMessageIds {
// game init, game load, disconnect, ...
    IdSetupGame=1,         // sent to a newly connected player
    IdSetupGameContinue=2, // continue the setup
    IdGameLoad=3,          // load/save the game to the client
    IdGameConnected=4,     // Client successfully connected to master
    IdSyncRandom=5,        // new random seed set - sync games
    IdDisconnect=6,        // KGame object disconnects from game
    IdGameSetupDone=7,     // New game client is now operational

// properties
    IdPlayerProperty=20,   // a player property changed
    IdGameProperty=21,     // a game property changed

// player management
    IdAddPlayer=30,         // add a player
    IdRemovePlayer=31,      // the player will be removed
    IdActivatePlayer=32,    // Activate a player
    IdInactivatePlayer=33,  // Inactivate a player
    IdTurn=34,              // Turn to be prepared

// to-be-categorized
    IdError=100,            // an error occurred
    IdPlayerInput=101,      // a player input occurred
    IdIOAdded=102,          // KGameIO got added to a player...init this IO

// special ids for computer player
    IdProcessQuery=220,     // Process queries data (process only)
    IdPlayerId=221,         // PlayerId got changed (process only)

    IdUser=256          // a user specified message
  };
};

#endif