kplayer.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 __KPLAYER_H_
#define __KPLAYER_H_

#include <QtCore/QObject>
#include <QtCore/QList>

#include "../libkdegamesprivate_export.h"

class KGame;
class KGameIO;
class KGamePropertyBase;
class KGamePropertyHandler;

class KPlayerPrivate;

class KDEGAMESPRIVATE_EXPORT KPlayer : public QObject
{
  Q_OBJECT

public:
      typedef QList<KGameIO*> KGameIOList;

      // KPlayer(KGame *,KGameIO * input=0);
      explicit KPlayer();

      virtual ~KPlayer();

      virtual int rtti() const;

      void Debug();

      // properties
      KGameIOList *ioList();

      void setGame(KGame *game);

      KGame *game() const;

      void setAsyncInput(bool a);

      bool asyncInput() const;

      bool isVirtual() const;

      void setVirtual(bool v);

      bool isActive() const;

      void setActive(bool v);

      quint32 id() const; 

      /* Set the players id. This is done automatically by
       * the game object when adding a new player!
       *
       * @param i the player id
       */
      void setId(quint32 i);

      int userId() const;

      /* Set the user defined players id.
       *
       * @param i the user defined player id
       */
      void setUserId(int i);

      int networkPriority() const;

      void setNetworkPriority(int b);

      KPlayer *networkPlayer() const;

      void setNetworkPlayer(KPlayer *p);

      // A name and group the player belongs to
      void setGroup(const QString& group);

      virtual const QString& group() const;

      void setName(const QString& name);

      virtual const QString& name() const;


      // set devices
      bool addGameIO(KGameIO *input);

      bool removeGameIO(KGameIO *input=0,bool deleteit=true);

      KGameIO *findRttiIO(int rtti) const;

      bool hasRtti(int rtti) const;

      // Message exchange
      virtual bool forwardInput(QDataStream &msg,bool transmit=true, quint32 sender=0);

      virtual bool forwardMessage(QDataStream &msg,int msgid,quint32 receiver=0,quint32 sender=0);

      // Game logic
      bool myTurn() const;

      bool setTurn(bool b,bool exclusive=true);


      // load/save
      virtual bool load(QDataStream &stream);

      virtual bool save(QDataStream &stream);

      void networkTransmission(QDataStream &stream,int msgid,quint32 sender);

      KGamePropertyBase* findProperty(int id) const;

      bool addProperty(KGamePropertyBase* data);

      int calcIOValue();

       KGamePropertyHandler* dataHandler();

Q_SIGNALS:
       void signalNetworkData(int msgid, const QByteArray& buffer, quint32 sender, KPlayer *me);

       void signalPropertyChanged(KGamePropertyBase *property,KPlayer *me);

protected Q_SLOTS:
      void sendProperty(int msgid, QDataStream& stream, bool* sent);
      void emitSignal(KGamePropertyBase *me);


private:
      void init();

private:
      friend class KPlayerPrivate;
      KPlayerPrivate *const d;

      Q_DISABLE_COPY(KPlayer)
};

#endif