X-Git-Url: http://de.git.xonotic.org/?p=xonotic%2Fdarkplaces.git;a=blobdiff_plain;f=protocol.h;h=7a97333da714e465a182fdf1bde91d30f3fa91ce;hp=639221ec84fd6787d7700d5beab2515b145f5b34;hb=9ed3f50e7c5d1db79d6258145329f31619617e6a;hpb=d57be67cb00229acb8564b92c8b7c58eeed8a0cb diff --git a/protocol.h b/protocol.h index 639221ec..7a97333d 100644 --- a/protocol.h +++ b/protocol.h @@ -8,7 +8,7 @@ of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. @@ -19,8 +19,19 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */ // protocol.h -- communications protocols -#define PROTOCOL_VERSION 15 -#define DPPROTOCOL_VERSION 96 +#ifndef PROTOCOL_H +#define PROTOCOL_H + +#define PROTOCOL_VERSION 15 +#define DPPROTOCOL_VERSION1 96 +#define DPPROTOCOL_VERSION2 97 +// LordHavoc: I think the 96-99 range was going to run out too soon... +// so here I jump to 3500 +#define DPPROTOCOL_VERSION3 3500 +// partial entity updates, changed entity origin updates back to quake style +// (RENDER_LOWPRECISION on by default, but the precision was changed from +// integer to 1/8th unit like quake) +#define DPPROTOCOL_VERSION4 3501 // model effects #define EF_ROCKET 1 // leave a trail @@ -40,11 +51,14 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. #define EF_ADDITIVE 32 #define EF_BLUE 64 #define EF_RED 128 -#define EF_DELTA 8388608 // LordHavoc: entity is delta compressed to save network bandwidth +#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 :) +#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_STEP 0x80000000 // internal client use only - present on MOVETYPE_STEP entities, not QC accessible (too many bits) @@ -110,7 +124,7 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. #define SU_PUNCHVEC1 (1<<16) #define SU_PUNCHVEC2 (1<<17) #define SU_PUNCHVEC3 (1<<18) -#define SU_UNUSED19 (1<<19) +#define SU_VIEWZOOM (1<<19) // byte factor (0 = 0.0 (not valid), 255 = 1.0) #define SU_UNUSED20 (1<<20) #define SU_UNUSED21 (1<<21) #define SU_UNUSED22 (1<<22) @@ -129,6 +143,8 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. #define SND_VOLUME (1<<0) // a byte #define SND_ATTENUATION (1<<1) // a byte #define SND_LOOPING (1<<2) // a long +#define SND_LARGEENTITY (1<<3) // a short and a byte (instead of a short) +#define SND_LARGESOUND (1<<4) // a short (instead of a byte) // defaults for clientinfo messages @@ -160,7 +176,7 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. #define svc_stufftext 9 // [string] stuffed into client's console buffer // the string should be \n terminated #define svc_setangle 10 // [angle3] set the view angle to this absolute value - + #define svc_serverinfo 11 // [long] version // [string] signon string // [string]..[0]model cache @@ -173,11 +189,11 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. #define svc_updatecolors 17 // [byte] [byte] #define svc_particle 18 // [vec3] #define svc_damage 19 - + #define svc_spawnstatic 20 // svc_spawnbinary 21 #define svc_spawnbaseline 22 - + #define svc_temp_entity 23 #define svc_setpause 24 // [byte] on / off @@ -202,14 +218,15 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. #define svc_hidelmp 36 // [string] slotname #define svc_skybox 37 // [string] skyname -#define svc_unusedlh1 -#define svc_fog 51 // unfinished +// LordHavoc: my svc_ range, 50-59 +#define svc_cgame 50 // [short] length [bytes] data +#define svc_unusedlh1 51 #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_spawnbaseline2 55 // short modelindex instead of byte #define svc_spawnstatic2 56 // short modelindex instead of byte -#define svc_unusedlh2 57 +#define svc_entities 57 // [int] deltaframe [int] thisframe [float vector] eye [variable length] entitydata #define svc_unusedlh3 58 #define svc_spawnstaticsound2 59 // [coord3] [short] samp [byte] vol [byte] aten @@ -222,6 +239,17 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. #define clc_move 3 // [usercmd_t] #define clc_stringcmd 4 // [string] message +// LordHavoc: my clc_ range, 50-59 +#define clc_ackentities 50 // [int] framenumber +#define clc_unusedlh1 51 +#define clc_unusedlh2 52 +#define clc_unusedlh3 53 +#define clc_unusedlh4 54 +#define clc_unusedlh5 55 +#define clc_unusedlh6 56 +#define clc_unusedlh7 57 +#define clc_unusedlh8 58 +#define clc_unusedlh9 59 // // temp entity events @@ -240,9 +268,9 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. #define TE_TELEPORT 11 // [vector] origin #define TE_EXPLOSION2 12 // [vector] origin [byte] startcolor [byte] colorcount -// PGM 01/21/97 +// PGM 01/21/97 #define TE_BEAM 13 // [entity] entity [vector] start [vector] end -// PGM 01/21/97 +// PGM 01/21/97 // Nehahra effects used in the movie (TE_EXPLOSION3 also got written up in a QSG tutorial, hence it's not marked NEH) #define TE_EXPLOSION3 16 // [vector] origin [coord] red [coord] green [coord] blue @@ -265,29 +293,219 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. #define TE_SMALLFLASH 72 // [vector] origin #define TE_CUSTOMFLASH 73 // [vector] origin [byte] radius / 8 - 1 [byte] lifetime / 256 - 1 [byte] red [byte] green [byte] blue #define TE_FLAMEJET 74 // [vector] origin [vector] velocity [byte] count +#define TE_PLASMABURN 75 // [vector] origin +// LordHavoc: Tei grabbed these codes +#define TE_TEI_G3 76 // [vector] start [vector] end [vector] angles +#define TE_TEI_SMOKE 77 // [vector] origin [vector] dir [byte] count +#define TE_TEI_BIGEXPLOSION 78 // [vector] origin +#define TE_TEI_PLASMAHIT 79 // [vector} origin [vector] dir [byte] count + +// these are bits for the 'flags' field of the entity_state_t #define RENDER_STEP 1 #define RENDER_GLOWTRAIL 2 #define RENDER_VIEWMODEL 4 #define RENDER_EXTERIORMODEL 8 +#define RENDER_LOWPRECISION 16 // send as low precision coordinates to save bandwidth +#define RENDER_COLORMAPPED 32 +#define RENDER_SHADOW 64 // cast shadow typedef struct { - double time; // time this state was built + double time; // time this state was built + vec3_t origin; + vec3_t angles; + int number; // entity number this state is for unsigned short active; // true if a valid state unsigned short modelindex; unsigned short frame; unsigned short effects; - vec3_t origin; - vec3_t angles; - byte colormap; - byte skin; - byte alpha; - byte scale; - byte glowsize; - byte glowcolor; - byte flags; + qbyte colormap; + qbyte skin; + qbyte alpha; + qbyte scale; + qbyte glowsize; + qbyte glowcolor; + qbyte flags; } entity_state_t; +typedef struct +{ + double time; + int framenum; + int firstentity; // index into entitydata, modulo MAX_ENTITY_DATABASE + int endentity; // index into entitydata, firstentity + numentities +} +entity_frameinfo_t; + +#define MAX_ENTITY_HISTORY 64 +#define MAX_ENTITY_DATABASE (MAX_EDICTS * 2) + +typedef struct +{ + // 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 + // when removing updates from database, nudge down frames array to only contain useful frames + // this logic should explain better: + // if (numframes >= MAX_ENTITY_HISTORY || (frames[numframes - 1].endentity - frames[0].firstentity) + entitiestoadd > MAX_ENTITY_DATABASE) + // flushdatabase(); + // note: if numframes == 0, insert at start (0 in entitydata) + // the only reason this system is used is to avoid copying memory when frames are removed + int numframes; + // server only: last acknowledged frame + int ackframe; + // the current state in the database + vec3_t eye; + // table of entities in the entityhistorydata + entity_frameinfo_t frames[MAX_ENTITY_HISTORY]; + // entities + entity_state_t entitydata[MAX_ENTITY_DATABASE]; +} +entity_database_t; + +// build entity data in this, to pass to entity read/write functions +typedef struct +{ + double time; + int framenum; + int numentities; + vec3_t eye; + entity_state_t entitydata[MAX_ENTITY_DATABASE]; +} +entity_frame_t; + + +// DPPROTOCOL_VERSION4 +#define MAX_ENTITIES_PER_FRAME 1024 + +// DPPROTOCOL_VERSION4 +typedef struct +{ + double time; + int framenum; + + // partial updates only update a certain range of entities in one update + // note that if end <= start the range wrapped (full update) + // note also that this means that the range can not be empty, if there is no update, don't write an update! + int range_start; + int range_end; + + // entities + entity_state_t entity[MAX_ENTITIES_PER_FRAME]; +} +entity_frame4_t; + +// DPPROTOCOL_VERSION4 +typedef struct +{ + // note: each frame contains a limited number of entities, so in + // situations with a high maximum data rate AND large number of entities, + // updates may be partial despite a high data rate. + + // current frame number + int currentframe; + // number of frames waiting to be committed to database + int numframes; + // the current state in the database + vec3_t currenteye; + // current entity states + entity_state_t currententity[MAX_EDICTS]; + // frame updates (each one limited in size) that have not yet been + // committed to currententitydata + entity_frame4_t frames[MAX_ENTITY_HISTORY]; +} +entity_database4_t; + +// LordHavoc: these are in approximately sorted order, according to cost and +// likelyhood of being used for numerous objects in a frame + +// note that the bytes are not written/read in this order, this is only the +// order of the bits to minimize overhead from extend bytes + +// enough to describe a nail, gib, shell casing, bullet hole, or rocket +#define E_ORIGIN1 (1<<0) +#define E_ORIGIN2 (1<<1) +#define E_ORIGIN3 (1<<2) +#define E_ANGLE1 (1<<3) +#define E_ANGLE2 (1<<4) +#define E_ANGLE3 (1<<5) +#define E_MODEL1 (1<<6) +#define E_EXTEND1 (1<<7) + +// enough to describe almost anything +#define E_FRAME1 (1<<8) +#define E_EFFECTS1 (1<<9) +#define E_ALPHA (1<<10) +#define E_SCALE (1<<11) +#define E_COLORMAP (1<<12) +#define E_SKIN (1<<13) +#define E_FLAGS (1<<14) +#define E_EXTEND2 (1<<15) + +// players, custom color glows, high model numbers +#define E_FRAME2 (1<<16) +#define E_MODEL2 (1<<17) +#define E_EFFECTS2 (1<<18) +#define E_GLOWSIZE (1<<19) +#define E_GLOWCOLOR (1<<20) +#define E_UNUSED1 (1<<21) +#define E_UNUSED2 (1<<22) +#define E_EXTEND3 (1<<23) + +#define E_SOUND1 (1<<24) +#define E_SOUNDVOL (1<<25) +#define E_SOUNDATTEN (1<<26) +#define E_UNUSED4 (1<<27) +#define E_UNUSED5 (1<<28) +#define E_UNUSED6 (1<<29) +#define E_UNUSED7 (1<<30) +#define E_EXTEND4 (1<<31) + void ClearStateToDefault(entity_state_t *s); + +// (server) clears the database to contain no frames (thus delta compression +// compresses against nothing) +void EntityFrame_ClearDatabase(entity_database_t *d); +// (server and client) removes frames older than 'frame' from database +void EntityFrame_AckFrame(entity_database_t *d, int frame); +// (server) clears frame, to prepare for adding entities +void EntityFrame_Clear(entity_frame_t *f, vec3_t eye); +// (server) allocates an entity slot in frame, returns NULL if full +entity_state_t *EntityFrame_NewEntity(entity_frame_t *f, int number); +// (server and client) reads a frame from the database +void EntityFrame_FetchFrame(entity_database_t *d, int framenum, entity_frame_t *f); +// (server and client) adds a entity_frame to the database, for future +// reference +void EntityFrame_AddFrame(entity_database_t *d, entity_frame_t *f); +// (server) writes a frame to network stream +void EntityFrame_Write(entity_database_t *d, entity_frame_t *f, sizebuf_t *msg); +// (client) reads a frame from network stream +void EntityFrame_Read(entity_database_t *d); +// (client) returns the frame number of the most recent frame recieved +int EntityFrame_MostRecentlyRecievedFrameNum(entity_database_t *d); + +// (server) clears the database to contain blank entities and no frames (thus +// delta compression compresses against nothing) +void EntityFrame4_ClearDatabase(entity_database4_t *d); +// (server and client) updates database to requested frame by commiting +// awaiting frames until the desired frame is reached +void EntityFrame4_AckFrame(entity_database4_t *d, int frame); +// (server) clears frame, to prepare for adding entities +void EntityFrame4_Clear(entity_frame4_t *f, vec3_t eye); +// (server) allocates an entity slot in frame, returns NULL if full +entity_state_t *EntityFrame4_NewEntity(entity_frame4_t *f, int number); +// (server and client) reads a frame from the database +void EntityFrame4_FetchFrame(entity_database4_t *d, int framenum, entity_frame4_t *f); +// (server and client) adds a entity_frame to the database, for future +// reference +void EntityFrame4_AddFrame(entity_database4_t *d, entity_frame4_t *f); +// (server) writes a frame to network stream +void EntityFrame4_Write(entity_database4_t *d, entity_frame4_t *f, sizebuf_t *msg); +// (client) reads a frame from network stream +void EntityFrame4_Read(entity_database4_t *d); +// (client) returns the frame number of the most recent frame recieved +int EntityFrame4_MostRecentlyRecievedFrameNum(entity_database4_t *d); + +#endif +