KGameIO Class Reference

Base class for IO devices for games. More...

#include <kgameio.h>

Inheritance diagram for KGameIO:

[legend]Collaboration diagram for KGameIO:

[legend]List of all members.

Public Types
enum	IOMode {   GenericIO = 1, KeyIO = 2, MouseIO = 4, ProcessIO = 8,   ComputerIO = 16 }
	Identifies the KGameIO via the rtti function. More...
Signals
void	signalPrepareTurn (QDataStream &stream, bool turn, KGameIO *io, bool *send)
	Signal generated when KPlayer::myTurn changes.
Public Member Functions
	KGameIO ()
	Constructs a KGameIO object.
	KGameIO (KPlayer *)
virtual	~KGameIO ()
void	Debug ()
	Gives debug output of the game status.
virtual int	rtti () const =0
	Run time idendification.
KPlayer *	player () const
	This function returns the player who owns this IO.
KGame *	game () const
	Equivalent to player()->game().
void	setPlayer (KPlayer *p)
	Sets the player to which this IO belongs to.
virtual void	initIO (KPlayer *p)
	Init this device by setting the player and e.g.
virtual void	notifyTurn (bool b)
	Notifies the IO device that the player's setTurn had been called Called by KPlayer.
bool	sendInput (QDataStream &stream, bool transmit=true, Q_UINT32 sender=0)
	Send an input message using KPlayer::forwardInput.

---

Detailed Description

Base class for IO devices for games.

This is the master class for creating IO game devices. You cannot use it directly. Either take one of the classes derived from it or you have to create your own IO class derived from it (more probably).

The idea behind this class is to provide a common interface for input devices into your game. By programming a KGameIO device you need not distinguish the actual IO in the game anymore. All work is done by the IO's. This allows very easy reuse in other games as well. A further advantage of using the IO's is that you can exchange the control of a player at runtime. E.g. you switch a player to be controlled by the computer or vice versa.

To achieve this you have to make all of your player inputs through a KGameIO. You will usually call KGameIO::sendInput to do so.

Author:

Martin Heni <martin@heni-online.de>

Definition at line 55 of file kgameio.h.

---

Member Enumeration Documentation

enum KGameIO::IOMode

Identifies the KGameIO via the rtti function. Enumerator: GenericIO  KeyIO  MouseIO  ProcessIO  ComputerIO  Definition at line 75 of file kgameio.h.

---

Constructor & Destructor Documentation

KGameIO::KGameIO (   )

Constructs a KGameIO object. Definition at line 40 of file kgameio.cpp.

KGameIO::KGameIO (  KPlayer *   )

Definition at line 46 of file kgameio.cpp. References KPlayer::addGameIO(), and player(). Here is the call graph for this function:

KGameIO::~KGameIO (   )  [virtual]

Definition at line 56 of file kgameio.cpp. References player(), and KPlayer::removeGameIO(). Here is the call graph for this function:

---

Member Function Documentation

void KGameIO::Debug (   )

Gives debug output of the game status. Definition at line 109 of file kgameio.cpp. References player(), and rtti(). Here is the call graph for this function:

KGame * KGameIO::game (   )  const

Equivalent to player()->game(). Returns: the KGame object of this player Definition at line 91 of file kgameio.cpp. References KPlayer::game(), and player(). Here is the call graph for this function:

void KGameIO::initIO (  KPlayer *  p  )  [virtual]

Init this device by setting the player and e.g. sending an init message to the device. This initialisation message is very useful for computer players as you can transmit the game status to them and only update this status in the setTurn commands. Called by KPlayer::addGameIO only! Reimplemented in KGameProcessIO. Definition at line 66 of file kgameio.cpp. References setPlayer(). Referenced by KPlayer::addGameIO(), and KGameProcessIO::initIO(). Here is the call graph for this function:

void KGameIO::notifyTurn (  bool  b  )  [virtual]

Notifies the IO device that the player's setTurn had been called Called by KPlayer. This emits signalPrepareTurn and sends the turn if the send parameter is set to true. Parameters: b  turn is true/false Reimplemented in KGameProcessIO. Definition at line 71 of file kgameio.cpp. References KPlayer::id(), player(), sendInput(), and signalPrepareTurn(). Here is the call graph for this function:

KPlayer* KGameIO::player (   )  const [inline]

This function returns the player who owns this IO. Returns: the player this IO device is plugged into Definition at line 89 of file kgameio.h. Referenced by Debug(), KGameMouseIO::eventFilter(), KGameKeyIO::eventFilter(), game(), KGameIO(), KGameProcessIO::notifyTurn(), notifyTurn(), KGameProcessIO::receivedMessage(), sendInput(), ~KGameIO(), and KGameProcessIO::~KGameProcessIO().

virtual int KGameIO::rtti (   )  const [pure virtual]

Run time idendification. Predefined values are from IOMode You MUST overwrite this in derived classes! Returns: rtti value Implemented in KGameKeyIO, KGameMouseIO, KGameProcessIO, and KGameComputerIO. Referenced by Debug().

bool KGameIO::sendInput (  QDataStream &  stream, bool  transmit = true, Q_UINT32  sender = 0 )

Send an input message using KPlayer::forwardInput. Definition at line 100 of file kgameio.cpp. References KPlayer::forwardInput(), and player(). Referenced by KGameMouseIO::eventFilter(), KGameKeyIO::eventFilter(), notifyTurn(), and KGameProcessIO::receivedMessage(). Here is the call graph for this function:

void KGameIO::setPlayer (  KPlayer *  p  )  [inline]

Sets the player to which this IO belongs to. This is done automatically when adding a device to a player Parameters: p  the player Definition at line 104 of file kgameio.h. Referenced by initIO(), and KPlayer::removeGameIO().

void KGameIO::signalPrepareTurn (  QDataStream &  stream, bool  turn, KGameIO *  io, bool *  send )  [signal]

Signal generated when KPlayer::myTurn changes. This can either be when you get the turn status or when you lose it. The datastream has to be filled with a move. If you set (or leave) the send parameter to FALSE then nothing happens: the datastream will be ignored. If you set it to TRUE sendInput is used to send the move. Often you want to ignore this signal (leave send=FALSE) and send the message later. This is usually the case for a human player as he probably doesn't react immediately. But you can still use this e.g. to notify the player about the turn change. Example: void GameWindow::slotPrepareTurn(QDataStream &stream,bool b,KGameIO *input,bool * ) { KPlayer *player=input->player(); if (!player->myTurn()) return ; if (!b) return ; // only do something on setTurn(true) stream << 1 << 2 << 3; // Some data for the process } Parameters: io  the KGameIO object itself stream  the stream into which the move will be written turn  the argument of setTurn send  set this to true to send the generated move using sendInput Referenced by KGameProcessIO::notifyTurn(), and notifyTurn().

---

The documentation for this class was generated from the following files:

• kgameio.h
• kgameio.cpp

---