Changes between Version 2 and Version 3 of code/howto/Synchronisable

Timestamp:

Sep 25, 2008, 9:26:33 PM (16 years ago)

Author:

scheusso

Comment:

—

code/howto/Synchronisable

@@ -6 +6 @@
 See also [wiki:network/Synchronisable] for more information.
 == Basic steps ==
- 1. {{{ #include "network/Synchronisable.h" }}}
- 2. make sure your class inherits from Synchronisable:
+ 1. Include the appropriate header file:
+{{{ 
+#include "network/Synchronisable.h" 
+}}}
+ 2. Make sure your class inherits from Synchronisable:
 {{{
 class XYZ : public network::Synchronisable { ... };
 }}}
- 3. create the function void registerAllVariables() and call REGISTERDATA or REGISTERSTRING functions in order to register these variables for synchronisation:
+ 3. Create the function void registerAllVariables() and call REGISTERDATA or REGISTERSTRING functions in order to register these variables for synchronisation:
 {{{
 void XYZ::registerAllVariables(){
@@ -18 +21 @@
 }
 }}}
- 4. make sure registerAllVariables() gets called in the constructor:
+ 4. Make sure registerAllVariables() gets called in the constructor:
 {{{
 XYZ::XYZ(){
@@ -25 +28 @@
 }
 }}}
- 5. implement the create() function and put all the code that needs some synchronisable variables to be set inside it:
+ 5. Implement the create() function and put all the code that needs some synchronisable variables to be set inside it:
 {{{
 bool XYZ::create(){
@@ -33 +36 @@
 == Multidirectional synchronisation ==
 If you want to have a variable synchronised back to the server, follow these steps (additional to/instead of the above):
- 1. register the variable with REGISTERDATA_WITHDIR:
+ 1. Register the variable with REGISTERDATA_WITHDIR:
 {{{
 void XYZ::registerAllVariables(){