Changes between Version 7 and Version 8 of code/howto/Synchronisable

Timestamp:

Sep 29, 2008, 2:22:47 PM (16 years ago)

Author:

scheusso

Comment:

—

code/howto/Synchronisable

@@ -2 +2 @@
 This is a step-by-step guide to make a class XYZ synchronisable. 
  * Synchronisable classes are registered to the network engine to be transfered/synched between client and server.
- * If you want your class to get transfered, you have to ''register'' every important variable to the network (e.g. position, speed, health, ...). But only register variables that are absolutely neccessary (e.g. no local variables).
+ * If you want your class to get transfered, you have to ''register'' every important variable to the network (e.g. position, speed, health, ...). But only register variables that are absolutely neccessary (e.g. no local variables and '''no temporary copies/variables''').
  * The default transfer ''direction'' of variables (and objects) is from server to the clients only. If you want to change this for a certain variable (and object), call REGISTERDATA_WITHDIR(varname, direction) or REGISTERSTRING_WITHDIR(stringname, direction) instead of REGISTERDATA or REGISTERSTRING.[[br]]
 See also [wiki:network/Synchronisable Synchronisable reference] for more information.
@@ -19 +19 @@
 {{{
 void XYZ::registerAllVariables(){
-REGISTERDATA(somevariable);
-REGISTERSTRING(meshSrcName_);
+  REGISTERDATA(somevariable);
+  REGISTERSTRING(meshSrcName_);
 }
 }}}
@@ -26 +26 @@
 {{{
 XYZ::XYZ(){
-registerAllVariables();
+  registerAllVariables();
 // do not work with synchronisable variables in your constructor (except initialisation)
 }
@@ -33 +33 @@
 {{{
 bool XYZ::create(){
-this->ogreMesh_.setMesh(meshSrcName_);
+  this->ogreMesh_.setMesh(meshSrcName_);
 }
 }}}
@@ -73 +73 @@
   //Memberfunctions
   void registerAllVariables(){
+    // !!! Note: this only works, because getPosition returns a reference and not a copy !!!
+    // !!! Never use REGISTERDATA/STRING with local/temporary copies !!!
     REGISTERDATA_WITHDIR(node_->getPosition().x, network::direction::bidirectional);
     REGISTERDATA_WITHDIR(node_->getPosition().y, network::direction::bidirectional);
@@ -99 +101 @@
 
 == Example class that inherits indirectly from Synchronisable == #indirect
-These kind of classes only have to do some steps:
+This kind of class only has to do some steps:
 {{{
 class ABC: public XYZ {