Changes between Version 4 and Version 5 of code/doc/network/Synchronisable

Timestamp:

Sep 29, 2008, 2:36:40 PM (16 years ago)

Author:

scheusso

Comment:

—

code/doc/network/Synchronisable

@@ -13 +13 @@
  * network::direction::bidirectional (==0x3) sync in both directions
 
-Every object and every registered variable have a syncdirection (default: toclient).
+Every object and every registered variable has a syncdirection (default: toclient).
 
 In order to synchronise a variable in a class, these steps must be done:
@@ -63 +63 @@
 
 === Synchronisation Direction ===
-As mentioned above, the default direction of the Synchronisation is toclient. If you want to change this, you need to register the variable with either REGISTERDATA_WITHDIR or REGISTERSTRING_WITHDIR (normally per-class, see below). Additionally you have to set the global syncdirection (per-object, see below) to directional or toclient (again: not recommended
+As mentioned above, the default direction of the Synchronisation is toclient. If you want to change this, you need to register the variable with either REGISTERDATA_WITHDIR or REGISTERSTRING_WITHDIR (normally per-class, see below). Additionally you have to set the global syncdirection (per-object, see below) to bidirectional or toclient (again: not recommended)
 {{{
 int SomeClass::syncback;
-REGISTERDATA_WITHDIR(i, network::direction::bidirectional); // put this inside registerAllVariables
+REGISTERDATA_WITHDIR(syncback, network::direction::bidirectional); // put this inside registerAllVariables
 this->setObjectMode(network::direction::bidirectional); // put this wherever you want (it is possible to do this only for specific objects specified by objectID)
 }}}
@@ -73 +73 @@
 When synchronising an object the first time to a client (or server) the following steps occur:
  * A new object gets created with the appropriate class
- * by calling the constructor of the class also registerAllVariables gets called (make sure this is in your constructor)
- * After construction of the object finished the data get updated (all variables previously registered by registerAllVariables)
+ * By calling the constructor of the class registerAllVariables gets called (make sure this is in your constructor)
+ * After construction of the object is finished the data gets updated (all variables previously registered by registerAllVariables)
  * After that the create() function gets called.
 
-Because we don't have the data at construction time, all functions that need member variables (with data from the server) must be called inside create(). See example class for details.
+Because we don't have the data at construction time, '''all functions that need member variables''' (with data from the server) '''must be called inside create()''' (instead of inside the constructor). See example class for details.
 
 == Preconditions ==