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

Timestamp:

Sep 25, 2008, 9:24:37 PM (16 years ago)

Author:

scheusso

Comment:

—

code/howto/Synchronisable

@@ -1 +1 @@
 = Howt to make an object class Synchronisable =
+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).
+ * 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] for more information.
 == Basic steps ==
@@ -27 +31 @@
 }
 }}}
+== 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:
+{{{
+void XYZ::registerAllVariables(){
+  REGISTERDATA_WITHDIR(someVar_, network::direction::bidirectional); // synchronises in both directions
+  REGISTERSTRING_WITHDIR(someString_, network::direction::toserver); // only transfers from client to server (not recommended)
+}
+}}}
+ 2. Change the default object synchronisation direction in order to enable the above variables to get transfered to the server:
+{{{
+XYZ::XYZ(){
+  registerAllVariables();
+  setObjectMode(network::direction::bidirectional);
+  ...
+}
+}}}