<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en_US" xml:lang="en_US">
<head>
<title>libkdegames: kgamemessage.h Source File (libkdegames)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta http-equiv="pics-label" content='(pics-1.1 "http://www.icra.org/ratingsv02.html" comment "ICRAonline DE v2.0" l gen true for "http://www.kde.org" r (nz 1 vz 1 lz 1 oz 1 cb 1) "http://www.rsac.org/ratingsv01.html" l gen true for "http://www.kde.org" r (n 0 s 0 v 0 l 0))' />
<meta name="trademark" content="KDE e.V." />
<meta name="description" content="K Desktop Environment Homepage, KDE.org" />
<meta name="MSSmartTagsPreventParsing" content="true" />
<meta name="robots" content="all" />
<link rel="shortcut icon" href="../../favicon.ico" />
<link rel="stylesheet" media="screen" type="text/css" title="APIDOX" href="doxygen.css" />
</head>
<body>
<div id="nav_header_top" align="right">
<a href="#content" class="doNotDisplay" accesskey="2">Skip to main content ::</a>
<a href="../.."><img id="nav_header_logo" alt="Home" align="left" src="../../kde_gear_64.png" border="0" /></a>
<span class="doNotDisplay">::</span>
<div id="nav_header_title" align="left">KDE API Reference</div>
</div>
<div id="nav_header_bottom" align="right">
<span class="doNotDisplay">:: <a href="#navigation" accesskey="5">Skip to Link Menu</a><br/></span>
<div id="nav_header_bottom_right" style="text-align: left;">
/ <a href="../..">API Reference</a>
/ <a href=".">libkdegames</a>
</div>
</div>
<table id="main" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td valign="top" class="menuheader" height="0"></td>
<td id="contentcolumn" valign="top" rowspan="2" >
<div id="content" style="padding-top: 0px;"><div style="width:100%; margin: 0px; padding: 0px;">
<a name="content"></a>
<!-- Generated by Doxygen 1.5.5 -->
<h1>kgamemessage.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> This file is part of the KDE games library</span>
<a name="l00003"></a>00003 <span class="comment"> Copyright (C) 2001 Martin Heni (martin@heni-online.de)</span>
<a name="l00004"></a>00004 <span class="comment"> Copyright (C) 2001 Andreas Beckermann (b_mann@gmx.de)</span>
<a name="l00005"></a>00005 <span class="comment"></span>
<a name="l00006"></a>00006 <span class="comment"> This library is free software; you can redistribute it and/or</span>
<a name="l00007"></a>00007 <span class="comment"> modify it under the terms of the GNU Library General Public</span>
<a name="l00008"></a>00008 <span class="comment"> License version 2 as published by the Free Software Foundation.</span>
<a name="l00009"></a>00009 <span class="comment"></span>
<a name="l00010"></a>00010 <span class="comment"> This library is distributed in the hope that it will be useful,</span>
<a name="l00011"></a>00011 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00012"></a>00012 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
<a name="l00013"></a>00013 <span class="comment"> Library General Public License for more details.</span>
<a name="l00014"></a>00014 <span class="comment"></span>
<a name="l00015"></a>00015 <span class="comment"> You should have received a copy of the GNU Library General Public License</span>
<a name="l00016"></a>00016 <span class="comment"> along with this library; see the file COPYING.LIB. If not, write to</span>
<a name="l00017"></a>00017 <span class="comment"> the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,</span>
<a name="l00018"></a>00018 <span class="comment"> Boston, MA 02110-1301, USA.</span>
<a name="l00019"></a>00019 <span class="comment">*/</span>
<a name="l00020"></a>00020 <span class="comment">/*</span>
<a name="l00021"></a>00021 <span class="comment"> $Id: kgamemessage.h 465369 2005-09-29 14:33:08Z mueller $</span>
<a name="l00022"></a>00022 <span class="comment">*/</span>
<a name="l00023"></a>00023 <span class="preprocessor">#ifndef __KGAMEMSG_H_</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#define __KGAMEMSG_H_</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include <qdatastream.h></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include <kdemacros.h></span>
<a name="l00028"></a>00028
<a name="l00029"></a>00029 <span class="keyword">class </span>KDE_EXPORT KGameMessage
<a name="l00030"></a>00030 {
<a name="l00031"></a>00031 <span class="keyword">public</span>:
<a name="l00044"></a>00044 <span class="keyword">static</span> Q_UINT32 createPlayerId(<span class="keywordtype">int</span> player, Q_UINT32 game);
<a name="l00045"></a>00045
<a name="l00054"></a>00054 <span class="keyword">static</span> <span class="keywordtype">int</span> rawPlayerId(Q_UINT32 playerid);
<a name="l00055"></a>00055
<a name="l00063"></a>00063 <span class="keyword">static</span> Q_UINT32 rawGameId(Q_UINT32 playerid);
<a name="l00064"></a>00064
<a name="l00071"></a>00071 <span class="keyword">static</span> <span class="keywordtype">bool</span> isPlayer(Q_UINT32 <span class="keywordtype">id</span>);
<a name="l00072"></a>00072
<a name="l00079"></a>00079 <span class="keyword">static</span> <span class="keywordtype">bool</span> isGame(Q_UINT32 <span class="keywordtype">id</span>);
<a name="l00080"></a>00080
<a name="l00088"></a>00088 <span class="keyword">static</span> <span class="keywordtype">void</span> createHeader(QDataStream &msg, Q_UINT32 sender, Q_UINT32 receiver, <span class="keywordtype">int</span> msgid);
<a name="l00089"></a>00089
<a name="l00095"></a>00095 <span class="keyword">static</span> <span class="keywordtype">void</span> extractHeader(QDataStream &msg,Q_UINT32 &sender, Q_UINT32 &receiver, <span class="keywordtype">int</span> &msgid);
<a name="l00096"></a>00096
<a name="l00100"></a>00100 <span class="keyword">static</span> <span class="keywordtype">void</span> createPropertyHeader(QDataStream &msg, <span class="keywordtype">int</span> <span class="keywordtype">id</span>);
<a name="l00101"></a>00101
<a name="l00105"></a>00105 <span class="keyword">static</span> <span class="keywordtype">void</span> extractPropertyHeader(QDataStream &msg, <span class="keywordtype">int</span> &<span class="keywordtype">id</span>);
<a name="l00106"></a>00106
<a name="l00110"></a>00110 <span class="keyword">static</span> <span class="keywordtype">void</span> createPropertyCommand(QDataStream &msg, <span class="keywordtype">int</span> cmdid, <span class="keywordtype">int</span> pid, <span class="keywordtype">int</span> cmd);
<a name="l00111"></a>00111
<a name="l00115"></a>00115 <span class="keyword">static</span> <span class="keywordtype">void</span> extractPropertyCommand(QDataStream &msg, <span class="keywordtype">int</span> &pid, <span class="keywordtype">int</span> &cmd);
<a name="l00116"></a>00116
<a name="l00120"></a>00120 <span class="keyword">static</span> <span class="keywordtype">int</span> version();
<a name="l00121"></a>00121
<a name="l00130"></a>00130 <span class="keyword">static</span> QString messageId2Text(<span class="keywordtype">int</span> msgid);
<a name="l00131"></a>00131
<a name="l00132"></a>00132
<a name="l00138"></a>00138 <span class="comment">// please document every new id with a short comment</span>
<a name="l00139"></a>00139 <span class="keyword">enum</span> GameMessageIds {
<a name="l00140"></a>00140 <span class="comment">// game init, game load, disconnect, ...</span>
<a name="l00141"></a>00141 IdSetupGame=1, <span class="comment">// sent to a newly connected player</span>
<a name="l00142"></a>00142 IdSetupGameContinue=2, <span class="comment">// continue the setup</span>
<a name="l00143"></a>00143 IdGameLoad=3, <span class="comment">// load/save the game to the client</span>
<a name="l00144"></a>00144 IdGameConnected=4, <span class="comment">// Client successfully connected to master</span>
<a name="l00145"></a>00145 IdSyncRandom=5, <span class="comment">// new random seed set - sync games</span>
<a name="l00146"></a>00146 IdDisconnect=6, <span class="comment">// KGame object disconnects from game</span>
<a name="l00147"></a>00147 IdGameSetupDone=7, <span class="comment">// New game client is now operational</span>
<a name="l00148"></a>00148
<a name="l00149"></a>00149 <span class="comment">// properties</span>
<a name="l00150"></a>00150 IdPlayerProperty=20, <span class="comment">// a player property changed</span>
<a name="l00151"></a>00151 IdGameProperty=21, <span class="comment">// a game property changed</span>
<a name="l00152"></a>00152
<a name="l00153"></a>00153 <span class="comment">// player management</span>
<a name="l00154"></a>00154 IdAddPlayer=30, <span class="comment">// add a player</span>
<a name="l00155"></a>00155 IdRemovePlayer=31, <span class="comment">// the player will be removed</span>
<a name="l00156"></a>00156 IdActivatePlayer=32, <span class="comment">// Activate a player</span>
<a name="l00157"></a>00157 IdInactivatePlayer=33, <span class="comment">// Inactivate a player</span>
<a name="l00158"></a>00158 IdTurn=34, <span class="comment">// Turn to be prepared</span>
<a name="l00159"></a>00159
<a name="l00160"></a>00160 <span class="comment">// to-be-categorized</span>
<a name="l00161"></a>00161 IdError=100, <span class="comment">// an error occurred</span>
<a name="l00162"></a>00162 IdPlayerInput=101, <span class="comment">// a player input occurred</span>
<a name="l00163"></a>00163 IdIOAdded=102, <span class="comment">// KGameIO got added to a player...init this IO</span>
<a name="l00164"></a>00164
<a name="l00165"></a>00165 <span class="comment">// special ids for computer player</span>
<a name="l00166"></a>00166 IdProcessQuery=220, <span class="comment">// Process queries data (process only)</span>
<a name="l00167"></a>00167 IdPlayerId=221, <span class="comment">// PlayerId got changed (process only)</span>
<a name="l00168"></a>00168
<a name="l00169"></a>00169 IdUser=256 <span class="comment">// a user specified message</span>
<a name="l00170"></a>00170 };
<a name="l00171"></a>00171 };
<a name="l00172"></a>00172
<a name="l00173"></a>00173 <span class="preprocessor">#endif</span>
</pre></div></div>
</div></div>
</td>
</tr>
<tr>
<td valign="top" id="leftmenu" width="25%">
<a name="navigation"></a>
<div class="menu_box"><h2>libkdegames</h2>
<div class="nav_list">
<ul><li><a href="index.html">Main Page</a></li><li><a href="hierarchy.html">Class Hierarchy</a></li><li><a href="classes.html">Alphabetical List</a></li><li><a href="annotated.html">Class List</a></li><li><a href="files.html">File List</a></li><li><a href="functions.html">Class Members</a></li><li><a href="pages.html">Related Pages</a></li></ul>
<!--
<h2>Class Picker</h2>
<div style="text-align: center;">
<form name="guideform">
<select name="guidelinks" style="width:100%;" onChange="window.location=document.guideform.guidelinks.options[document.guideform.guidelinks.selectedIndex].value">
<option value="annotated.html">-- Choose --</option>
<option value="classKCanvasRootPixmap.html">kcanvasrootpixmap</option>, <option value="classKCardDialog.html">kcarddialog</option>, <option value="classKChat.html">kchat</option>, <option value="classKChatBase.html">kchatbase</option>, <option value="classKChatBaseText.html">kchatbasetext</option>, <option value="classKExtHighscore_1_1Item.html">kexthighscore::item</option>, <option value="classKExtHighscore_1_1ItemArray.html">kexthighscore::itemarray</option>, <option value="classKExtHighscore_1_1Manager.html">kexthighscore::manager</option>, <option value="classKExtHighscore_1_1MultiplayerScores.html">kexthighscore::multiplayerscores</option>, <option value="classKExtHighscore_1_1Score.html">kexthighscore::score</option>, <option value="classKGame.html">kgame</option>, <option value="classKGameChat.html">kgamechat</option>, <option value="classKGameComputerIO.html">kgamecomputerio</option>, <option value="classKGameConnectDialog.html">kgameconnectdialog</option>, <option value="classKGameDialog.html">kgamedialog</option>, <option value="classKGameDialogChatConfig.html">kgamedialogchatconfig</option>, <option value="classKGameDialogConfig.html">kgamedialogconfig</option>, <option value="classKGameErrorDialog.html">kgameerrordialog</option>, <option value="classKGameErrorMessageDialog.html">kgameerrormessagedialog</option>, <option value="classKGameIO.html">kgameio</option>, <option value="classKGameKeyIO.html">kgamekeyio</option>, <option value="classKGameLCD.html">kgamelcd</option>, <option value="classKGameLCDClock.html">kgamelcdclock</option>, <option value="classKGameLCDList.html">kgamelcdlist</option>, <option value="classKGameMisc.html">kgamemisc</option>, <option value="classKGameMouseIO.html">kgamemouseio</option>, <option value="classKGameNetwork.html">kgamenetwork</option>, <option value="classKGameProcess.html">kgameprocess</option>, <option value="classKGameProcessIO.html">kgameprocessio</option>, <option value="classKGameProgress.html">kgameprogress</option>, <option value="classKGameProperty.html">kgameproperty</option>, <option value="classKGamePropertyBase.html">kgamepropertybase</option>, <option value="classKGamePropertyHandler.html">kgamepropertyhandler</option>, <option value="classKGameSequence.html">kgamesequence</option>, <option value="classKGrid2D_1_1Generic.html">kgrid2d::generic</option>, <option value="classKGrid2D_1_1Hexagonal.html">kgrid2d::hexagonal</option>, <option value="classKGrid2D_1_1HexagonalBase.html">kgrid2d::hexagonalbase</option>, <option value="classKGrid2D_1_1Square.html">kgrid2d::square</option>, <option value="classKGrid2D_1_1SquareBase.html">kgrid2d::squarebase</option>, <option value="classKHighscore.html">khighscore</option>, <option value="classKMessageClient.html">kmessageclient</option>, <option value="classKMessageDirect.html">kmessagedirect</option>, <option value="classKMessageIO.html">kmessageio</option>, <option value="classKMessageServer.html">kmessageserver</option>, <option value="classKMessageServerSocket.html">kmessageserversocket</option>, <option value="classKMessageSocket.html">kmessagesocket</option>, <option value="classKPlayer.html">kplayer</option>, <option value="classKScoreDialog.html">kscoredialog</option>, <option value="classKStdGameAction.html">kstdgameaction</option>,
</select>
</form>
</div>
-->
</div></div>
<div class="menu_box"><h2>API Dox</h2>
<div class="nav_list">
<ul>
<li><a href="../../libkdegames/html/index.html">libkdegames</a></li>
</ul></div></div>
</td>
</tr>
</table>
<span class="doNotDisplay">
<a href="http://www.kde.org/" accesskey="8">KDE Home</a> |
<a href="http://accessibility.kde.org/" accesskey="9">KDE Accessibility Home</a> |
<a href="http://www.kde.org/media/accesskeys.php" accesskey="0">Description of Access Keys</a>
</span>
<div style="height: 8px"></div>
<div id="footer">
<div id="footer_left">
Maintained by <a href="mailto:groot@kde.org">Adriaan de Groot</a>
and
<a href="mailto:winter@kde.org">Allen Winter</a>.
<br/>
KDE and K Desktop Environment are trademarks of <a href="http://www.kde.org/areas/kde-ev/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
<a href="http://www.kde.org/contact/impressum.php">Legal</a>
</div>
<div id="footer_right"><img src="/media/images/footer_right.png" style="margin: 0px" alt="" /></div>
</div>
<!--
WARNING: DO NOT SEND MAIL TO THE FOLLOWING EMAIL ADDRESS! YOU WILL
BE BLOCKED INSTANTLY AND PERMANENTLY!
<a href="mailto:aaaatrap-425acc3b5374943f@kde.org">Block me</a>
WARNING END
-->
</body>
</html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-release
>
by-pkgid
>
ea24284f03fd4a8a4b64047514d93f64
>
files
>
312
