Changes between Version 5 and Version 6 of code/doc/Network

Timestamp:

Sep 13, 2008, 2:39:57 PM (16 years ago)

Author:

scheusso

Comment:

—

code/doc/Network

@@ -25 +25 @@
 == 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:
-   * REGISTERDATA/REGISTERSTRING: these functions register a variable (to the Network Engine) that needs synchronisation
-   * setObjectMode: this function sets the direction of synchronisation (server->client / server<->client / server<-client)
- * 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), that need synchronisation, to the network engine by calling REGISTERDATA and/or REGISTERSTRING
-     * create: (as described above)
-     * set appropriate synchronisation direction (default: server->client) by calling setObjectMode
-
-
-''' Synchronisable functions:'''[[BR]]
-''REGISTERDATA(varname)''[[BR]]
-Use this makro to synchronise a membervariable of a class (like position, velocity, ...). This makro sets the sync-direction of the variable to server->client
-{{{
-int SomeClass::i; // membervariable i
-REGISTERDATA(i);
-}}}
-''REGISTERDATA_WITHMODE(varname, mode)''[[BR]]
-Use this makro if you want to sync a variable using a different direction than the default. 
-{{{
-int SomeClass::i; //membervariable i
-REGISTERDATA_WITHMODE(i, network::direction::toclient); //same as REGISTERDATA(i)
-//or
-REGISTERDATA_WITHMODE(i, network::direction::toserver); //sync i only to the server (be carefull when using this)
-//or
-REGISTERDATA_WITHMODE(i, network::direction::bidirectional); //sync i in both directions
-}}}
-
-''REGISTERSTRING(stringname)''[[BR]]
-same as REGISTERDATA but for strings
-
-''REGISTERSTRING_WITHMODE(stringname, mode)''[[BR]]
-same as REGISTERDATA_WITHMODE but for strings
-
-''setObjectMode''[[BR]]
-this sets the sync direction of the whole object (default: server->client).
-'''Note:''' if you don't call setObjectMode with a value other than network::direction::toclient then the variables will only be synchronised to the client (if at all)
+The [wiki:network/Synchronisable Synchronisable] class is a base class of all Objects that need to be synchronised (e.g. SpaceShip, Model, Projectile, etc.). It is the interface between the ObjectHierarchy and the Network Engine. For more information about this go [wiki:network/Synchronisable here].
 === Host ===
+The [wiki:network/Host Host] class is the Base class of the Server and Client classes. It provides some static functions:
+ * network::Host::running(): return true, if a server or client is running
+ * network::Host::getPlayerID(): returns the player id of a client (this is only a temporary hack until we have a PlayerManager)
+ * network::Host::getShipID(): return the objectID of the players ship (also a temporary hack)
+ * network::Host::isServer(): return true/false (whether we are in server/client mode)
+ * other functions (not really meant to be used outside the network engine)