KGamePropertyBase

Search for usage in LXR

#include <KGame/KGameProperty>

Inheritance diagram for KGamePropertyBase:

Public Types

enum  PropertyCommandIds {
  CmdLock = 1, CmdAt = 51, CmdResize = 52, CmdFill = 53,
  CmdSort = 54, CmdInsert = 61, CmdAppend = 62, CmdRemove = 63,
  CmdClear = 64
}
 
enum  PropertyDataIds {
  IdGroup = 1, IdUserId = 2, IdAsyncInput = 3, IdTurn = 4,
  IdName = 5, IdGameStatus = 6, IdMaxPlayer = 7, IdMinPlayer = 8,
  IdGrabInput = 16, IdReleaseInput = 17, IdCommand, IdUser = 256,
  IdAutomatic = 0x7000
}
 
enum  PropertyPolicy { PolicyUndefined = 0, PolicyClean = 1, PolicyDirty = 2, PolicyLocal = 3 }
 

Public Member Functions

 KGamePropertyBase ()
 
 KGamePropertyBase (int id, KGame *parent)
 
 KGamePropertyBase (int id, KGamePropertyHandler *owner)
 
 KGamePropertyBase (int id, KPlayer *parent)
 
virtual void command (QDataStream &stream, int msgid, bool isSender=false)
 
int id () const
 
bool isDirty () const
 
bool isEmittingSignal () const
 
bool isLocked () const
 
bool isOptimized () const
 
virtual void load (QDataStream &s)=0
 
bool lock ()
 
PropertyPolicy policy () const
 
int registerData (int id, KGame *owner, const QString &name=QString())
 
int registerData (int id, KGamePropertyHandler *owner, const QString &name=QString())
 
int registerData (int id, KGamePropertyHandler *owner, PropertyPolicy p, const QString &name=QString())
 
int registerData (int id, KPlayer *owner, const QString &name=QString())
 
int registerData (KGamePropertyHandler *owner, PropertyPolicy p=PolicyUndefined, const QString &name=QString())
 
virtual void save (QDataStream &s)=0
 
void setEmittingSignal (bool p)
 
void setOptimized (bool p)
 
void setPolicy (PropertyPolicy p)
 
virtual const type_info * typeinfo ()
 
bool unlock (bool force=false)
 
void unregisterData ()
 

Protected Member Functions

void emitSignal ()
 
bool sendProperty ()
 
bool sendProperty (const QByteArray &b)
 
void setDirty (bool d)
 
void setLock (bool l)
 

Protected Attributes

union KGamePropertyBase::Flags mFlags
 
KGamePropertyHandlermOwner
 

Detailed Description

Base class of KGameProperty.

The KGamePropertyBase class is the base class of KGameProperty. See KGameProperty for further information.

Author
Andreas Beckermann b_man[email protected][email protected][email protected]x.de

Definition at line 36 of file kgameproperty.h.

Member Enumeration Documentation

◆ PropertyCommandIds

Commands for advanced properties (qint8)

Definition at line 65 of file kgameproperty.h.

◆ PropertyPolicy

The policy of the property.

This can be PolicyClean (setValue uses send), PolicyDirty (setValue uses changeValue) or PolicyLocal (setValue uses setLocal).

A "clean" policy means that the property is always the same on every client. This is achieved by calling send which actually changes the value only when the message from the MessageServer is received.

A "dirty" policy means that as soon as setValue is called the property is changed immediately. And additionally sent over network. This can sometimes lead to bugs as the other clients do not immediately have the same value. For more information see changeValue.

PolicyLocal means that a KGameProperty behaves like ever "normal" variable. Whenever setValue is called (e.g. using "=") the value of the property is changes immediately without sending it over network. You might want to use this if you are sure that all clients set the property at the same time.

Definition at line 103 of file kgameproperty.h.

Constructor & Destructor Documentation

◆ KGamePropertyBase() [1/2]

KGamePropertyBase::KGamePropertyBase ( int  id,
KGamePropertyHandler owner 
)

Constructs a KGamePropertyBase object and calls registerData.

Parameters
idThe id of this property. MUST be UNIQUE! Used to send and receive changes in the property of the player automatically via network.
ownerThe owner of the object. Must be a KGamePropertyHandler which manages the changes made to this object, i.e. which will send the new data

Definition at line 31 of file kgameproperty.cpp.

◆ KGamePropertyBase() [2/2]

KGamePropertyBase::KGamePropertyBase ( )

Creates a KGamePropertyBase object without an owner.

Remember to call registerData!

Definition at line 37 of file kgameproperty.cpp.

Member Function Documentation

◆ command()

void KGamePropertyBase::command ( QDataStream stream,
int  msgid,
bool  isSender = false 
)
virtual

send a command to advanced properties like arrays

Parameters
streamThe stream containing the data of the command
msgidThe ID of the command - see PropertyCommandIds
isSenderwhether this client is also the sender of the command

Definition at line 190 of file kgameproperty.cpp.

◆ emitSignal()

void KGamePropertyBase::emitSignal ( )
protected

Causes the parent object to emit a signal on value change.

Definition at line 180 of file kgameproperty.cpp.

◆ id()

int KGamePropertyBase::id ( ) const
inline
Returns
The id of this property

Definition at line 249 of file kgameproperty.h.

◆ isDirty()

bool KGamePropertyBase::isDirty ( ) const
inline
Returns
Whether this property is "dirty". See also setDirty

Definition at line 185 of file kgameproperty.h.

◆ isEmittingSignal()

bool KGamePropertyBase::isEmittingSignal ( ) const
inline

See also setEmittingSignal.

Returns
Whether this property emits a signal on value change

Definition at line 159 of file kgameproperty.h.

◆ isLocked()

bool KGamePropertyBase::isLocked ( ) const
inline

A locked property can only be changed by the player who has set the lock.

See also setLocked

Returns
Whether this property is currently locked.

Definition at line 195 of file kgameproperty.h.

◆ isOptimized()

bool KGamePropertyBase::isOptimized ( ) const
inline

See also setOptimize.

Returns
Whether the property optimizes access (signals,network traffic)

Definition at line 177 of file kgameproperty.h.

◆ load()

virtual void KGamePropertyBase::load ( QDataStream s)
pure virtual

This will read the value of this property from the stream.

You MUST overwrite this method in order to use this class

Parameters
sThe stream to read from

Implemented in KGameProperty< type >, KGameProperty< QString >, KGameProperty< int >, KGameProperty< qint8 >, and KGameProperty< unsigned int >.

◆ lock()

bool KGamePropertyBase::lock ( )

A locked property can only be changed by the player who has set the lock.

You can only call this if isLocked is false. A message is sent over network so that the property is locked for all players except you.

Returns
returns false if the property can not be locked, i.e. it is already locked

Definition at line 147 of file kgameproperty.cpp.

◆ policy()

PropertyPolicy KGamePropertyBase::policy ( ) const
inline
Returns
The default policy of the property

Definition at line 140 of file kgameproperty.h.

◆ registerData() [1/5]

int KGamePropertyBase::registerData ( int  id,
KGame owner,
const QString name = QString() 
)

This is an overloaded member function, provided for convenience.

It differs from the above function only in what argument(s) it accepts.

Definition at line 66 of file kgameproperty.cpp.

◆ registerData() [2/5]

int KGamePropertyBase::registerData ( int  id,
KGamePropertyHandler owner,
const QString name = QString() 
)

This is an overloaded member function, provided for convenience.

It differs from the above function only in what argument(s) it accepts.

Definition at line 81 of file kgameproperty.cpp.

◆ registerData() [3/5]

int KGamePropertyBase::registerData ( int  id,
KGamePropertyHandler owner,
PropertyPolicy  p,
const QString name = QString() 
)

You have to register a KGamePropertyBase before you can use it.

You MUST call this before you can use KGamePropertyBase!

Parameters
idthe id of this KGamePropertyBase object. The id MUST be unique, i.e. you cannot have two properties with the same id for one player, although (currently) nothing prevents you from doing so. But you will get strange results!
ownerThe owner of this data. This will send the data using KPropertyHandler::sendProperty whenever you call send
pIf not 0 you can set the policy of the property here
nameif not 0 you can assign a name to this property

Definition at line 86 of file kgameproperty.cpp.

◆ registerData() [4/5]

int KGamePropertyBase::registerData ( int  id,
KPlayer owner,
const QString name = QString() 
)

This is an overloaded member function, provided for convenience.

It differs from the above function only in what argument(s) it accepts.

Definition at line 71 of file kgameproperty.cpp.

◆ registerData() [5/5]

int KGamePropertyBase::registerData ( KGamePropertyHandler owner,
PropertyPolicy  p = PolicyUndefined,
const QString name = QString() 
)

This is an overloaded member function, provided for convenience.

It differs from the above function only in what argument(s) it accepts. In particular you can use this function to create properties which will have an automatic id assigned. The new id is returned.

Definition at line 76 of file kgameproperty.cpp.

◆ save()

virtual void KGamePropertyBase::save ( QDataStream s)
pure virtual

Write the value into a stream.

MUST be overwritten

Implemented in KGameProperty< type >, KGameProperty< QString >, KGameProperty< int >, KGameProperty< qint8 >, and KGameProperty< unsigned int >.

◆ sendProperty() [1/2]

bool KGamePropertyBase::sendProperty ( )
protected

Forward the data to the owner of this property which then sends it over network.

save is used to store the data into a stream so you have to make sure that function is working properly if you implement your own property!

Note: this sends the current property!

Might be obsolete - KGamePropertyArray still uses it. Is this a bug or correct?

Definition at line 119 of file kgameproperty.cpp.

◆ sendProperty() [2/2]

bool KGamePropertyBase::sendProperty ( const QByteArray b)
protected

Forward the data to the owner of this property which then sends it over network.

save is used to store the data into a stream so you have to make sure that function is working properly if you implement your own property!

This function is used by send to send the data over network. This does not send the current value but the explicitly given value.

Returns
TRUE if the message could be sent successfully, otherwise FALSE

Definition at line 133 of file kgameproperty.cpp.

◆ setDirty()

void KGamePropertyBase::setDirty ( bool  d)
inlineprotected

Sets the "dirty" flag of the property.

If a property is "dirty" i.e. KGameProperty::setLocal has been called there is no guarantee that all clients share the same value. You have to ensure this yourself e.g. by calling KGameProperty::setLocal on every client. You can also ignore the dirty flag and continue working withe the property depending on your situation.

Definition at line 331 of file kgameproperty.h.

◆ setEmittingSignal()

void KGamePropertyBase::setEmittingSignal ( bool  p)
inline

Sets this property to emit a signal on value changed.

As the properties do not inherit QObject for optimization this signal is emitted via the KPlayer or KGame object

Definition at line 150 of file kgameproperty.h.

◆ setLock()

void KGamePropertyBase::setLock ( bool  l)
protected

A locked property can only be changed by the player who has set the lock.

You can only call this if isLocked is false. A message is sent over network so that the property is locked for all players except you. Usually you use lock and unlock to access this property

Definition at line 165 of file kgameproperty.cpp.

◆ setOptimized()

void KGamePropertyBase::setOptimized ( bool  p)
inline

Sets this property to try to optimize signal and network handling by not sending it out when the property value is not changed.

Definition at line 168 of file kgameproperty.h.

◆ setPolicy()

void KGamePropertyBase::setPolicy ( PropertyPolicy  p)
inline

Changes the consistency policy of a property.

The PropertyPolicy is one of PolicyClean (defaulz), PolicyDirty or PolicyLocal.

It is up to you to decide how you want to work.

Definition at line 132 of file kgameproperty.h.

◆ typeinfo()

virtual const type_info* KGamePropertyBase::typeinfo ( )
inlinevirtual
Returns
a type_info of the data this property contains.

Reimplemented in KGameProperty< type >, KGameProperty< QString >, KGameProperty< int >, KGameProperty< qint8 >, and KGameProperty< unsigned int >.

Definition at line 257 of file kgameproperty.h.

◆ unlock()

bool KGamePropertyBase::unlock ( bool  force = false)

A locked property can only be changed by the player who has set the lock.

You can only call this if isLocked is false. A message is sent over network so that the property is locked for all players except you.

Returns
returns false if the property can not be locked, i.e. it is already locked

Definition at line 156 of file kgameproperty.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Thu Dec 8 2022 03:51:57 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.