]> de.git.xonotic.org Git - xonotic/darkplaces.git/blobdiff - protocol.h
added DP_SV_MODELFLAGS_AS_EFFECTS extension, this adds EF_ROCKET and
[xonotic/darkplaces.git] / protocol.h
index 1054a27b604f0768ead3bee486fd623c69960ae8..04faf61ea390d727f81e868d589bea24366369af 100644 (file)
@@ -31,14 +31,15 @@ int Protocol_NumberForEnum(protocolversion_t p);
 void Protocol_Names(char *buffer, size_t buffersize);
 
 // model effects
-#define        EF_ROCKET       1                       // leave a trail
-#define        EF_GRENADE      2                       // leave a trail
-#define        EF_GIB          4                       // leave a trail
-#define        EF_ROTATE       8                       // rotate (bonus items)
-#define        EF_TRACER       16                      // green split trail
-#define        EF_ZOMGIB       32                      // small blood trail
-#define        EF_TRACER2      64                      // orange split trail + rotate
-#define        EF_TRACER3      128                     // purple trail
+#define        MF_ROCKET       1                       // leave a trail
+#define        MF_GRENADE      2                       // leave a trail
+#define        MF_GIB          4                       // leave a trail
+#define        MF_ROTATE       8                       // rotate (bonus items)
+#define        MF_TRACER       16                      // green split trail
+#define        MF_ZOMGIB       32                      // small blood trail
+#define        MF_TRACER2      64                      // orange split trail + rotate
+#define        MF_TRACER3      128                     // purple trail
+
 // entity effects
 #define        EF_BRIGHTFIELD                  1
 #define        EF_MUZZLEFLASH                  2
@@ -48,19 +49,34 @@ void Protocol_Names(char *buffer, size_t buffersize);
 #define EF_ADDITIVE                            32
 #define EF_BLUE                                        64
 #define EF_RED                                 128
-#define EF_DELTA                               8388608 // LordHavoc: (obsolete) entity is delta compressed to save network bandwidth  (no longer used)
-#define EF_LOWPRECISION                        4194304 // LordHavoc: entity is low precision (integer coordinates) to save network bandwidth
-// effects/model (can be used as model flags or entity effects)
-#define        EF_REFLECTIVE                   256             // LordHavoc: shiny metal objects :)  (not currently supported)
-#define EF_FULLBRIGHT                  512             // LordHavoc: fullbright
-#define EF_FLAME                               1024    // LordHavoc: on fire
-#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_DOUBLESIDED                 32768   //[515]: disable cull face for this entity
-
-#define EF_STEP                                        0x80000000 // internal client use only - present on MOVETYPE_STEP entities, not QC accessible (too many bits)
+#define EF_UNUSED8                             256
+#define EF_FULLBRIGHT                  512                     // LordHavoc: fullbright
+#define EF_FLAME                               1024            // LordHavoc: on fire
+#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_DOUBLESIDED                 32768           //[515]: disable cull face for this entity
+#define EF_UNUSED16                            65536
+#define EF_UNUSED17                            131072
+#define EF_UNUSED18                            262144
+#define EF_UNUSED19                            524288
+#define EF_UNUSED20                            1048576
+#define EF_UNUSED21                            2197152
+#define EF_LOWPRECISION                        4194304         // LordHavoc: entity is low precision (integer coordinates) to save network bandwidth  (serverside only)
+#define EF_UNUSED23                            8388608
+#define EF_ROCKET                              16777216        // leave a trail
+#define EF_GRENADE                             33554432        // leave a trail
+#define EF_GIB                                 67108864        // leave a trail
+#define EF_ROTATE                              134217728       // rotate (bonus items)
+#define EF_TRACER                              268435456       // green split trail
+#define EF_ZOMGIB                              536870912       // small blood trail
+#define EF_TRACER2                             1073741824      // orange split trail + rotate
+#define EF_TRACER3                             0x80000000      // purple trail
+
+// internaleffects bits (no overlap with EF_ bits):
+#define INTEF_FLAG1QW                          1
+#define INTEF_FLAG2QW                          2
 
 // flags for the pflags field of entities
 #define PFLAGS_NOSHADOW                        1
@@ -222,8 +238,8 @@ void Protocol_Names(char *buffer, size_t buffersize);
 #define        svc_hidelmp                     36              // [string] slotname
 #define        svc_skybox                      37              // [string] skyname
 
-// LordHavoc: my svc_ range, 50-59
-#define svc_cgame                      50              // [short] length [bytes] data
+// LordHavoc: my svc_ range, 50-69
+#define svc_downloaddata       50              // [int] start [short] size
 #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
@@ -234,6 +250,8 @@ void Protocol_Names(char *buffer, size_t buffersize);
 #define svc_entities           57              // [int] deltaframe [int] thisframe [float vector] eye [variable length] entitydata
 #define svc_csqcentities       58              // [short] entnum [variable length] entitydata ... [short] 0x0000
 #define        svc_spawnstaticsound2   59      // [coord3] [short] samp [byte] vol [byte] aten
+#define svc_trailparticles     60              // [short] entnum [short] effectnum [vector] start [vector] end
+#define svc_pointparticles     61              // [short] effectnum [vector] start [vector] end [short] count
 
 //
 // client to server
@@ -246,7 +264,7 @@ void Protocol_Names(char *buffer, size_t buffersize);
 
 // LordHavoc: my clc_ range, 50-59
 #define clc_ackframe   50              // [int] framenumber
-#define clc_unusedlh1  51
+#define clc_ackdownloaddata    51      // [int] start [short] size   (note: exact echo of latest values received in svc_downloaddata, packet-loss handling is in the server)
 #define clc_unusedlh2  52
 #define clc_unusedlh3  53
 #define clc_unusedlh4  54
@@ -315,14 +333,15 @@ void Protocol_Names(char *buffer, size_t buffersize);
 #define RENDER_COLORMAPPED 32
 #define RENDER_SHADOW 65536 // cast shadow
 #define RENDER_LIGHT 131072 // receive light
-#define RENDER_TRANSPARENT 262144 // can't light during opaque stage
-#define RENDER_NOCULLFACE 524288 // render as double sided (disable GL_CULL_FACE)
+#define RENDER_NOSELFSHADOW 262144 // render lighting on this entity before its own shadow is added to the scene
+// (note: all RENDER_NOSELFSHADOW entities are grouped together and rendered in a batch before their shadows are rendered, so they can not shadow eachother either)
 
-// this is 88 bytes
+// this is 96 bytes
 typedef struct entity_state_s
 {
        // ! means this is not sent to client
        double time; // ! time this state was built (used on client for interpolation)
+       float netcenter[3]; // ! for network prioritization, this is the center of the bounding box (which may differ from the origin)
        float origin[3];
        float angles[3];
        int number; // entity number this state is for
@@ -349,8 +368,9 @@ typedef struct entity_state_s
        unsigned char flags;
        unsigned char tagindex;
        unsigned char colormod[3];
+       unsigned char internaleffects; // INTEF_FLAG1QW and so on
        // padding to a multiple of 8 bytes (to align the double time)
-       unsigned char unused[6];
+       unsigned char unused;
 }
 entity_state_t;
 
@@ -358,6 +378,13 @@ entity_state_t;
 extern entity_state_t defaultstate;
 // reads a quake entity from the network stream
 void EntityFrameQuake_ReadEntity(int bits);
+// checks for stats changes and sets corresponding host_client->statsdeltabits
+// (also updates host_client->stats array)
+void Protocol_UpdateClientStats(const int *stats);
+// writes reliable messages updating stats (not used by DP6 and later
+// protocols which send updates in their WriteFrame function using a different
+// method of reliable messaging)
+void Protocol_WriteStatsReliable(void);
 // writes a list of quake entities to the network stream
 // (or as many will fit)
 void EntityFrameQuake_WriteFrame(sizebuf_t *msg, int numstates, const entity_state_t *states);
@@ -729,10 +756,6 @@ typedef struct entityframe5_database_s
        // (derived from states)
        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
 
        // this is used to decide which changestates to set each frame
@@ -750,15 +773,189 @@ 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);
 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_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);
+void EntityFrame5_WriteFrame(sizebuf_t *msg, entityframe5_database_t *d, int numstates, const entity_state_t *states, int viewentnum, int movesequence);
 
 extern cvar_t developer_networkentities;
 
+// QUAKEWORLD
+// server to client
+#define qw_svc_bad                             0
+#define qw_svc_nop                             1
+#define qw_svc_disconnect              2
+#define qw_svc_updatestat              3       // [byte] [byte]
+#define qw_svc_setview                 5       // [short] entity number
+#define qw_svc_sound                   6       // <see code>
+#define qw_svc_print                   8       // [byte] id [string] null terminated string
+#define qw_svc_stufftext               9       // [string] stuffed into client's console buffer
+#define qw_svc_setangle                        10      // [angle3] set the view angle to this absolute value
+#define qw_svc_serverdata              11      // [long] protocol ...
+#define qw_svc_lightstyle              12      // [byte] [string]
+#define qw_svc_updatefrags             14      // [byte] [short]
+#define qw_svc_stopsound               16      // <see code>
+#define qw_svc_damage                  19
+#define qw_svc_spawnstatic             20
+#define qw_svc_spawnbaseline   22
+#define qw_svc_temp_entity             23      // variable
+#define qw_svc_setpause                        24      // [byte] on / off
+#define qw_svc_centerprint             26      // [string] to put in center of the screen
+#define qw_svc_killedmonster   27
+#define qw_svc_foundsecret             28
+#define qw_svc_spawnstaticsound        29      // [coord3] [byte] samp [byte] vol [byte] aten
+#define qw_svc_intermission            30              // [vec3_t] origin [vec3_t] angle
+#define qw_svc_finale                  31              // [string] text
+#define qw_svc_cdtrack                 32              // [byte] track
+#define qw_svc_sellscreen              33
+#define qw_svc_smallkick               34              // set client punchangle to 2
+#define qw_svc_bigkick                 35              // set client punchangle to 4
+#define qw_svc_updateping              36              // [byte] [short]
+#define qw_svc_updateentertime 37              // [byte] [float]
+#define qw_svc_updatestatlong  38              // [byte] [long]
+#define qw_svc_muzzleflash             39              // [short] entity
+#define qw_svc_updateuserinfo  40              // [byte] slot [long] uid
+#define qw_svc_download                        41              // [short] size [size bytes]
+#define qw_svc_playerinfo              42              // variable
+#define qw_svc_nails                   43              // [byte] num [48 bits] xyzpy 12 12 12 4 8
+#define qw_svc_chokecount              44              // [byte] packets choked
+#define qw_svc_modellist               45              // [strings]
+#define qw_svc_soundlist               46              // [strings]
+#define qw_svc_packetentities  47              // [...]
+#define qw_svc_deltapacketentities     48              // [...]
+#define qw_svc_maxspeed                        49              // maxspeed change, for prediction
+#define qw_svc_entgravity              50              // gravity change, for prediction
+#define qw_svc_setinfo                 51              // setinfo on a client
+#define qw_svc_serverinfo              52              // serverinfo
+#define qw_svc_updatepl                        53              // [byte] [byte]
+// QUAKEWORLD
+// client to server
+#define qw_clc_bad                     0
+#define qw_clc_nop                     1
+#define qw_clc_move                    3               // [[usercmd_t]
+#define qw_clc_stringcmd       4               // [string] message
+#define qw_clc_delta           5               // [byte] sequence number, requests delta compression of message
+#define qw_clc_tmove           6               // teleport request, spectator only
+#define qw_clc_upload          7               // teleport request, spectator only
+// QUAKEWORLD
+// playerinfo flags from server
+// playerinfo always sends: playernum, flags, origin[] and framenumber
+#define        QW_PF_MSEC                      (1<<0)
+#define        QW_PF_COMMAND           (1<<1)
+#define        QW_PF_VELOCITY1 (1<<2)
+#define        QW_PF_VELOCITY2 (1<<3)
+#define        QW_PF_VELOCITY3 (1<<4)
+#define        QW_PF_MODEL             (1<<5)
+#define        QW_PF_SKINNUM           (1<<6)
+#define        QW_PF_EFFECTS           (1<<7)
+#define        QW_PF_WEAPONFRAME       (1<<8)          // only sent for view player
+#define        QW_PF_DEAD                      (1<<9)          // don't block movement any more
+#define        QW_PF_GIB                       (1<<10)         // offset the view height differently
+#define        QW_PF_NOGRAV            (1<<11)         // don't apply gravity for prediction
+// QUAKEWORLD
+// if the high bit of the client to server byte is set, the low bits are
+// client move cmd bits
+// ms and angle2 are allways sent, the others are optional
+#define QW_CM_ANGLE1   (1<<0)
+#define QW_CM_ANGLE3   (1<<1)
+#define QW_CM_FORWARD  (1<<2)
+#define QW_CM_SIDE             (1<<3)
+#define QW_CM_UP               (1<<4)
+#define QW_CM_BUTTONS  (1<<5)
+#define QW_CM_IMPULSE  (1<<6)
+#define QW_CM_ANGLE2   (1<<7)
+// QUAKEWORLD
+// the first 16 bits of a packetentities update holds 9 bits
+// of entity number and 7 bits of flags
+#define QW_U_ORIGIN1   (1<<9)
+#define QW_U_ORIGIN2   (1<<10)
+#define QW_U_ORIGIN3   (1<<11)
+#define QW_U_ANGLE2            (1<<12)
+#define QW_U_FRAME             (1<<13)
+#define QW_U_REMOVE            (1<<14)         // REMOVE this entity, don't add it
+#define QW_U_MOREBITS  (1<<15)
+// if MOREBITS is set, these additional flags are read in next
+#define QW_U_ANGLE1            (1<<0)
+#define QW_U_ANGLE3            (1<<1)
+#define QW_U_MODEL             (1<<2)
+#define QW_U_COLORMAP  (1<<3)
+#define QW_U_SKIN              (1<<4)
+#define QW_U_EFFECTS   (1<<5)
+#define QW_U_SOLID             (1<<6)          // the entity should be solid for prediction
+// QUAKEWORLD
+// temp entity events
+#define QW_TE_SPIKE                            0
+#define QW_TE_SUPERSPIKE               1
+#define QW_TE_GUNSHOT                  2
+#define QW_TE_EXPLOSION                        3
+#define QW_TE_TAREXPLOSION             4
+#define QW_TE_LIGHTNING1               5
+#define QW_TE_LIGHTNING2               6
+#define QW_TE_WIZSPIKE                 7
+#define QW_TE_KNIGHTSPIKE              8
+#define QW_TE_LIGHTNING3               9
+#define QW_TE_LAVASPLASH               10
+#define QW_TE_TELEPORT                 11
+#define QW_TE_BLOOD                            12
+#define QW_TE_LIGHTNINGBLOOD   13
+// QUAKEWORLD
+// effect flags
+#define QW_EF_BRIGHTFIELD              1
+#define QW_EF_MUZZLEFLASH              2
+#define QW_EF_BRIGHTLIGHT              4
+#define QW_EF_DIMLIGHT                         8
+#define QW_EF_FLAG1                            16
+#define QW_EF_FLAG2                            32
+#define QW_EF_BLUE                             64
+#define QW_EF_RED                              128
+
+#define QW_UPDATE_BACKUP 64
+#define QW_UPDATE_MASK (QW_UPDATE_BACKUP - 1)
+#define QW_MAX_PACKET_ENTITIES 64
+
+// note: QW stats are directly compatible with NQ
+// (but FRAGS, WEAPONFRAME, and VIEWHEIGHT are unused)
+// so these defines are not actually used by darkplaces, but kept for reference
+#define QW_STAT_HEALTH                 0
+//#define QW_STAT_FRAGS                        1
+#define QW_STAT_WEAPON                 2
+#define QW_STAT_AMMO                   3
+#define QW_STAT_ARMOR                  4
+//#define QW_STAT_WEAPONFRAME          5
+#define QW_STAT_SHELLS                 6
+#define QW_STAT_NAILS                  7
+#define QW_STAT_ROCKETS                        8
+#define QW_STAT_CELLS                  9
+#define QW_STAT_ACTIVEWEAPON   10
+#define QW_STAT_TOTALSECRETS   11
+#define QW_STAT_TOTALMONSTERS  12
+#define QW_STAT_SECRETS                        13 // bumped on client side by svc_foundsecret
+#define QW_STAT_MONSTERS               14 // bumped by svc_killedmonster
+#define QW_STAT_ITEMS                  15
+//#define QW_STAT_VIEWHEIGHT           16
+
+// build entity data in this, to pass to entity read/write functions
+typedef struct entityframeqw_snapshot_s
+{
+       double time;
+       qboolean invalid;
+       int num_entities;
+       entity_state_t entities[QW_MAX_PACKET_ENTITIES];
+}
+entityframeqw_snapshot_t;
+
+typedef struct entityframeqw_database_s
+{
+       entityframeqw_snapshot_t snapshot[QW_UPDATE_BACKUP];
+}
+entityframeqw_database_t;
+
+entityframeqw_database_t *EntityFrameQW_AllocDatabase(mempool_t *pool);
+void EntityFrameQW_FreeDatabase(entityframeqw_database_t *d);
+void EntityStateQW_ReadPlayerUpdate(void);
+void EntityFrameQW_CL_ReadFrame(qboolean delta);
+
 #endif