--- a/src/Network/Protocol.hh Fri Jan 16 21:24:45 2009 +0200
+++ b/src/Network/Protocol.hh Fri Jan 16 22:03:49 2009 +0200
@@ -1,10 +1,15 @@
#ifndef NETWORK_PROTOCOL_HH
#define NETWORK_PROTOCOL_HH
-/*
- * The network protocol is defined here :o
+/**
+ * @file
+ *
+ * Definitions for game network protocol
*/
+/**
+ * The various NetworkChannelIDs used with our NetworkSession
+ */
enum NetworkChannel {
/*
* Core channel used for NetworkSession
@@ -21,15 +26,27 @@
NETCHAN_TERRAIN_ARRAY = 0x0010,
};
+/**
+ * Various flags used with NETMSG_PLAYER_POSITION related to PhysicsObject state
+ */
enum NetworkPhysicsFlags {
NETWORK_PHYSICS_INAIR = 0x01,
NETWORK_PHYSICS_FACE_RIGHT = 0x02,
};
+/**
+ * Various flags used with NETMSG_PROJECTILE_* messages...
+ */
enum NetworkProjectileFlags {
+ /** NETMSG_PROJECTILE_DESTROY */
NETWORK_PROJECTILE_REMOVE_GROUND = 0x01,
};
+/**
+ * Various NetworkMessageIDs used with our NetworkSession's NetworkObjects.
+ *
+ * Message names are of the form 'NETMSG_<object type>_<action>'
+ */
enum NetworkMessage {
NETMSG_PACKET_INVALID = 0x0000,