Changes between Version 2 and Version 3 of code/doc/Network

Timestamp:

Sep 13, 2008, 1:21:30 PM (16 years ago)

Author:

scheusso

Comment:

—

code/doc/Network

@@ -1 +1 @@
 = Network =
 
-=== Overview ===
+== Overview ==
 The image below displays the basic concept of the Network Engine:
 
@@ -13 +13 @@
 The server and client components manage all the other network components. They call all necessary functions every network tick (not exactly the same as a game tick). 
 
-=== Components ===
+== Components ==
 This is a description of the important network components and/or classes:
 
@@ -23 +23 @@
 || [wiki:network/Synchronisable Synchronisable] || Interface class for all network objects, that need synchronisation || Synchronisable ||
 
-=== External API ===
+== External API ==
+=== Synchronisable ===
+The most important part of the Network API is the Synchronisable Class (see also [wiki:network/Synchronisable Synchronisable]):
+ * This class provides the functionality for objects to get synchronised over the network:
+   * registerVar(): this function registers a variable (in the Network Engine) that needs synchronisation
+   * create
+ * Every class that needs synchronisation must fullfill some dependencies:
+   * It must (public) inherit from Synchronisable
+   * It must have a default constructor
+   * All steps in object creation that need data (from the levelfile or the network) must be in the create() function
+   * It must implement the following functions:
+     * registerAllVariables: register all variables (currently only basic types and strings) to the network engine by calling either [wiki:network/registerdata REGISTERDATA] or [wiki:network/registerstring REGISTERSTRING]
+     * create: (as described above)
+=== Host ===