KGamePropertyHandler Class Reference
A collection class for KGameProperty objects. More...
#include <kgamepropertyhandler.h>
Inheritance diagram for KGamePropertyHandler:

Detailed Description
A collection class for KGameProperty objects.The KGamePropertyHandler class is some kind of a collection class for KGameProperty. You usually don't have to create one yourself, as both KPlayer and KGame provide a handler. In most cases you do not even have to care about the KGamePropertHandler. KGame and KPlayer implement all features of KGamePropertyHandler so you will rather use it there.
You have to use the KGamePropertyHandler as parent for all KGameProperty objects but you can also use KPlayer or KGame as parent - then KPlayer::dataHandler or KGame::dataHandler will be used.
Every KGamePropertyHandler must have - just like every KGameProperty - a unique ID. This ID is provided either in the constructor or in registerHandler. The ID is used to assign an incoming message (e.g. a changed property) to the correct handler. Inside the handler the property ID is used to change the correct property.
The constructor or registerHandler takes 3 addittional arguments: a receiver and two slots. The first slot is connected to signalSendMessage, the second to signalPropertyChanged. You must provide these in order to use the KGamePropertyHandler.
The most important function of KGamePropertyHandler is processMessage which assigns an incoming value to the correct property.
A KGamePropertyHandler is also used - indirectly using emitSignal - to emit a signal when the value of a property changes. This is done this way because a KGameProperty does not inherit QObject because of memory advantages. Many games can have dozens or even hundreds of KGameProperty objects so every additional variable in KGameProperty would be multiplied.
Definition at line 71 of file kgamepropertyhandler.h.
Constructor & Destructor Documentation
|
Construct an unregistered KGamePropertyHandler. You have to call registerHandler before you can use this handler! Definition at line 60 of file kgamepropertyhandler.cpp. |
|
Construct a registered handler.
References registerHandler(). |
Member Function Documentation
|
Register the handler with a parent. This is to use if the constructor without arguments has been chosen. Otherwise you need not call this.
References setId(), signalPropertyChanged(), and signalSendMessage(). Referenced by KGamePropertyHandler(). |
|
Main message process function. This has to be called by the parent's message event handler. If the id of the message agrees with the id of the handler, the message is extracted and processed. Otherwise false is returned. Example: if (mProperties.processMessage(stream,msgid,sender==gameId())) return ;
References KGamePropertyBase::command(), KGamePropertyBase::load(), and KGamePropertyBase::policy(). Referenced by load(). |
|
Referenced by clear(). |
|
Adds a KGameProperty property to the handler.
References KGamePropertyBase::id(). Referenced by KGame::addProperty(), and KGamePropertyBase::registerData(). |
|
Removes a property from the handler.
References KGamePropertyBase::id(). Referenced by clear(). |
|
returns a unique property ID starting called usually with a base of KGamePropertyBase::IdAutomatic. This is used internally by the property base to assign automtic id's. Not much need to call this yourself. Definition at line 264 of file kgamepropertyhandler.cpp. Referenced by KGamePropertyBase::registerData(). |
|
Loads properties from the datastream.
References lockDirectEmit(), processMessage(), and unlockDirectEmit(). Referenced by KGame::loadgame(). |
|
Saves properties into the datastream.
References KGamePropertyBase::id(), and KGamePropertyBase::save(). Referenced by KGame::savegame(). |
|
called by a property to send itself into the datastream. This call is simply forwarded to the parent object Definition at line 322 of file kgamepropertyhandler.cpp. References signalSendMessage(). Referenced by KGamePropertyBase::sendProperty(), and KGamePropertyBase::setLock(). |
|
called by a property to emit a signal This call is simply forwarded to the parent object Definition at line 303 of file kgamepropertyhandler.cpp. References signalPropertyChanged(). Referenced by KGamePropertyBase::emitSignal(). |
|
Referenced by propertyValue(). |
|
|
|
Clear the KGamePropertyHandler. Note that the properties are not deleted so if you created your KGameProperty objects dynamically like KGamePropertyInt* myProperty = new KGamePropertyInt(id, dataHandler()); dataHandler()->clear();
delete myProperty;
References KGamePropertyBase::id(), id(), removeProperty(), and KGamePropertyBase::unregisterData(). |
|
Use id as new ID for this KGamePropertyHandler. This is used internally only. Definition at line 88 of file kgamepropertyhandler.cpp. Referenced by registerHandler(). |
|
Calls KGamePropertyBase::setReadOnly(false) for all properties of this player. See also lockProperties Definition at line 246 of file kgamepropertyhandler.cpp. |
|
Set the policy for all kgame variables which are currently registerd in the KGame proeprty handler. See KGamePropertyBase::setPolicy
Referenced by KGame::setPolicy(). |
|
Called by the KGame or KPlayer object or the handler itself to delay emmiting of signals. Lockign keeps a counter and unlock is only achieved when every lock is canceld by an unlock. While this is set signals are quequed and only emmited after this is reset. Its deeper meaning is to prevent inconsistencies in a game load or network transfer where a emit could access a property not yet loaded or transmitted. Calling this by yourself you better know what your are doing. Definition at line 283 of file kgamepropertyhandler.cpp. Referenced by load(), and KGame::loadgame(). |
|
Removes the lock from the emitting of property signals. Corresponds to the lockIndirectEmits Definition at line 288 of file kgamepropertyhandler.cpp. References signalPropertyChanged(). Referenced by load(), and KGame::loadgame(). |
|
Returns the default policy for this property handler. All properties registered newly, will have this property. Definition at line 227 of file kgamepropertyhandler.cpp. Referenced by KGamePropertyBase::registerData(). |
|
Calls KGamePropertyBase::setReadOnly(true) for all properties of this handler. Use with care! This will even lock the core properties, like name, group and myTurn!!
|
|
Sends all properties which are marked dirty over the network. This will make a forced synchornisation of the properties and mark them all not dirty. Definition at line 269 of file kgamepropertyhandler.cpp. |
|
Reference to the internal dictionary. Definition at line 349 of file kgamepropertyhandler.cpp. |
|
In several situations you just want to have a QString of a KGameProperty object. This is the case in the KGameDebugDialog where the value of all properties is displayed. This function will provide you with such a QString for all the types used inside of all KGame classes. If you have a non-standard property (probably a self defined class or something like this) you also need to connect to signalRequestValue to make this function useful.
References KGamePropertyBase::id(), propertyName(), signalRequestValue(), and KGamePropertyBase::typeinfo(). |
|
Writes some debug output to the console. Definition at line 387 of file kgamepropertyhandler.cpp. References KGamePropertyBase::id(), KGamePropertyBase::isDirty(), KGamePropertyBase::isEmittingSignal(), KGamePropertyBase::isLocked(), KGamePropertyBase::isOptimized(), and KGamePropertyBase::policy(). |
|
This is emitted by a property. KGamePropertyBase::emitSignal calls emitSignal which emits this signal. This signal is emitted whenever the property is changed. Note that you can switch off this behaviour using KGamePropertyBase::setEmittingSignal in favor of performance. Note that you won't experience any performance loss using signals unless you use dozens or hundreds of properties which change very often. Referenced by emitSignal(), registerHandler(), and unlockDirectEmit(). |
|
This signal is emitted when a property needs to be sent. Only the parent has to react to this.
Referenced by registerHandler(), and sendProperty(). |
|
If you call propertyValue with a non-standard KGameProperty it is possible that the value cannot automatically be converted into a QString. Then this signal is emitted and asks you to provide the correct value. You probably want to use something like this to achieve this: #include <typeinfo> void slotRequestValue(KGamePropertyBase* p, QString& value) { if (*(p->typeinfo()) == typeid(MyType) { value = QString(((KGameProperty<MyType>*)p)->value()); } }
Referenced by propertyValue(). |
The documentation for this class was generated from the following files: