]> de.git.xonotic.org Git - xonotic/darkplaces.git/blobdiff - protocol.h
eliminated qbyte type, now uses unsigned char throughout the engine for this purpose
[xonotic/darkplaces.git] / protocol.h
index c0e96df386a83b25deb1b2bb1ad9e34a2b65e99e..27fbf6e2fce1e52e4486614562b91dd677c86dff 100644 (file)
@@ -22,26 +22,13 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 #ifndef PROTOCOL_H
 #define PROTOCOL_H
 
-// LordHavoc: I own protocol ranges 96, 97, 3500-3599
+// protocolversion_t is defined in common.h
 
-// quake or darkplaces extended quake entity protocol
-// (still used by TomazQuake and others)
-#define        PROTOCOL_QUAKE 15
-
-// neh_gl entity protocol
-// (failed QSG protocol, used only by nehahra movie)
-#define        PROTOCOL_NEHAHRAMOVIE 250
-
-// entityframe protocol
-#define        PROTOCOL_DARKPLACES1 96
-#define        PROTOCOL_DARKPLACES2 97
-
-// entityframe4 protocol
-#define        PROTOCOL_DARKPLACES3 3500
-#define PROTOCOL_DARKPLACES4 3501
-
-// entityframe5 protocol
-#define PROTOCOL_DARKPLACES5 3502
+protocolversion_t Protocol_EnumForName(const char *s);
+const char *Protocol_NameForEnum(protocolversion_t p);
+protocolversion_t Protocol_EnumForNumber(int n);
+int Protocol_NumberForEnum(protocolversion_t p);
+void Protocol_Names(char *buffer, size_t buffersize);
 
 // model effects
 #define        EF_ROCKET       1                       // leave a trail
@@ -70,6 +57,7 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 #define EF_STARDUST                            2048    // LordHavoc: showering sparks
 #define EF_NOSHADOW                            4096    // LordHavoc: does not cast a shadow
 #define EF_NODEPTHTEST                 8192    // LordHavoc: shows through walls
+#define EF_SELECTABLE                  16384   // LordHavoc: highlights when PRYDON_CLIENTCURSOR mouse is over it
 
 #define EF_STEP                                        0x80000000 // internal client use only - present on MOVETYPE_STEP entities, not QC accessible (too many bits)
 
@@ -107,7 +95,6 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 #define U_EFFECTS2             (1<<19) // 1 byte, this is .effects & 0xFF00 (second byte)
 #define U_GLOWSIZE             (1<<20) // 1 byte, encoding is float/4.0, unsigned, not sent if 0
 #define U_GLOWCOLOR            (1<<21) // 1 byte, palette index, default is 254 (white), this IS used for darklight (allowing colored darklight), however the particles from a darklight are always black, not sent if default value (even if glowsize or glowtrail is set)
-// LordHavoc: colormod feature has been removed, because no one used it
 #define U_COLORMOD             (1<<22) // 1 byte, 3 bit red, 3 bit green, 2 bit blue, this lets you tint an object artifically, so you could make a red rocket, or a blue fiend...
 #define U_EXTEND2              (1<<23) // another byte to follow
 // LordHavoc: second extend byte
@@ -236,10 +223,11 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
 // LordHavoc: my svc_ range, 50-59
 #define svc_cgame                      50              // [short] length [bytes] data
-#define svc_unusedlh1          51
+#define svc_updatestatubyte    51              // [byte] stat [byte] value
 #define svc_effect                     52              // [vector] org [byte] modelindex [byte] startframe [byte] framecount [byte] framerate
 #define svc_effect2                    53              // [vector] org [short] modelindex [short] startframe [byte] framecount [byte] framerate
-#define        svc_sound2                      54              // short soundindex instead of byte
+#define        svc_sound2                      54              // (obsolete in DP6 and later) short soundindex instead of byte
+#define        svc_precache            54              // [short] precacheindex [string] filename, precacheindex is + 0 for modelindex and +32768 for soundindex
 #define        svc_spawnbaseline2      55              // short modelindex instead of byte
 #define svc_spawnstatic2       56              // short modelindex instead of byte
 #define svc_entities           57              // [int] deltaframe [int] thisframe [float vector] eye [variable length] entitydata
@@ -256,7 +244,7 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 #define        clc_stringcmd   4               // [string] message
 
 // LordHavoc: my clc_ range, 50-59
-#define clc_ackentities        50              // [int] framenumber
+#define clc_ackframe   50              // [int] framenumber
 #define clc_unusedlh1  51
 #define clc_unusedlh2  52
 #define clc_unusedlh3  53
@@ -329,7 +317,7 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 #define RENDER_TRANSPARENT 262144 // can't light during opaque stage
 
 // this is 80 bytes
-typedef struct
+typedef struct entity_state_s
 {
        // ! means this is not sent to client
        double time; // ! time this state was built (used on client for interpolation)
@@ -357,14 +345,14 @@ typedef struct
        unsigned char glowcolor;
        unsigned char flags;
        unsigned char tagindex;
-       unsigned char colormod;
+       unsigned char colormod[3];
        // padding to a multiple of 8 bytes (to align the double time)
-       unsigned char unused[4];
+       unsigned char unused[2];
 }
 entity_state_t;
 
 // baseline state values
-entity_state_t defaultstate;
+extern entity_state_t defaultstate;
 // reads a quake entity from the network stream
 void EntityFrameQuake_ReadEntity(int bits);
 // writes a list of quake entities to the network stream
@@ -430,7 +418,7 @@ the Write function performs these steps:
 server updates entities in looping ranges, a frame consists of a range of visible entities (not always all visible entities),
 */
 
-typedef struct
+typedef struct entity_frameinfo_s
 {
        double time;
        int framenum;
@@ -442,7 +430,7 @@ entity_frameinfo_t;
 #define MAX_ENTITY_HISTORY 64
 #define MAX_ENTITY_DATABASE (MAX_EDICTS * 2)
 
-typedef struct
+typedef struct entityframe_database_s
 {
        // note: these can be far out of range, modulo with MAX_ENTITY_DATABASE to get a valid range (which may wrap)
        // start and end of used area, when adding a new update to database, store at endpos, and increment endpos
@@ -467,7 +455,7 @@ typedef struct
 entityframe_database_t;
 
 // build entity data in this, to pass to entity read/write functions
-typedef struct
+typedef struct entity_frame_s
 {
        double time;
        int framenum;
@@ -643,7 +631,7 @@ void EntityFrame4_CL_ReadFrame(void);
 // byte = bound(0, s->scale * 16, 255)
 #define E5_SCALE (1<<10)
 // flag
-#define E5_ORIGIN32 (1<<11) 
+#define E5_ORIGIN32 (1<<11)
 // flag
 #define E5_ANGLES16 (1<<12)
 // flag
@@ -669,8 +657,8 @@ void EntityFrame4_CL_ReadFrame(void);
 #define E5_EFFECTS32 (1<<20)
 // flag
 #define E5_FRAME16 (1<<21)
-// unused
-#define E5_UNUSED22 (1<<22)
+// byte[3] = s->colormod[0], s->colormod[1], s->colormod[2]
+#define E5_COLORMOD (1<<22)
 // bits >= (1<<24)
 #define E5_EXTEND3 (1<<23)
 
@@ -706,6 +694,7 @@ typedef struct entityframe5_packetlog_s
        int packetnumber;
        int numstates;
        entityframe5_changestate_t states[ENTITYFRAME5_MAXSTATES];
+       unsigned char statsdeltabits[(MAX_CL_STATS+7)/8];
 }
 entityframe5_packetlog_t;
 
@@ -713,25 +702,33 @@ typedef struct entityframe5_database_s
 {
        // number of the latest message sent to client
        int latestframenum;
+       // updated by WriteFrame for internal use
+       int viewentnum;
 
        // logs of all recently sent messages (between acked and latest)
        entityframe5_packetlog_t packetlog[ENTITYFRAME5_MAXPACKETLOGS];
 
+       // this goes up as needed and causes all the arrays to be reallocated
+       int maxedicts;
+
        // which properties of each entity have changed since last send
-       int deltabits[MAX_EDICTS];
+       int *deltabits; // [maxedicts]
        // priorities of entities (updated whenever deltabits change)
        // (derived from deltabits)
-       qbyte priorities[MAX_EDICTS];
+       unsigned char *priorities; // [maxedicts]
        // last frame this entity was sent on, for prioritzation
-       int updateframenum[MAX_EDICTS];
+       int *updateframenum; // [maxedicts]
 
        // database of current status of all entities
-       // (FIXME: this is 2.5mb per client even if most is unused!)
-       entity_state_t states[MAX_EDICTS];
+       entity_state_t *states; // [maxedicts]
        // which entities are currently active
        // (duplicate of the active bit of every state in states[])
        // (derived from states)
-       qbyte visiblebits[(MAX_EDICTS+7)/8];
+       unsigned char *visiblebits; // [(maxedicts+7)/8]
+
+       // delta compression of stats
+       unsigned char statsdeltabits[(MAX_CL_STATS+7)/8];
+       int stats[MAX_CL_STATS];
 
        // old notes
 
@@ -751,12 +748,12 @@ entityframe5_database_t;
 entityframe5_database_t *EntityFrame5_AllocDatabase(mempool_t *pool);
 void EntityFrame5_FreeDatabase(entityframe5_database_t *d);
 void EntityFrame5_ResetDatabase(entityframe5_database_t *d);
-int EntityState5_Priority(entityframe5_database_t *d, entity_state_t *view, entity_state_t *s, int changedbits, int age);
 void EntityState5_WriteUpdate(int number, const entity_state_t *s, int changedbits, sizebuf_t *msg);
 int EntityState5_DeltaBitsForState(entity_state_t *o, entity_state_t *n);
 void EntityFrame5_CL_ReadFrame(void);
-void EntityFrame5_AckFrame(entityframe5_database_t *d, int framenum, int viewentnum);
-void EntityFrame5_WriteFrame(sizebuf_t *msg, entityframe5_database_t *d, int numstates, const entity_state_t *states, int viewentnum);
+void EntityFrame5_LostFrame(entityframe5_database_t *d, int framenum);
+void EntityFrame5_AckFrame(entityframe5_database_t *d, int framenum);
+void EntityFrame5_WriteFrame(sizebuf_t *msg, entityframe5_database_t *d, int numstates, const entity_state_t *states, int viewentnum, int *stats, int movesequence);
 
 extern cvar_t developer_networkentities;