server.h

Go to the documentation of this file.

/*
Copyright (C) 1996-1997 Id Software, Inc.
 
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
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.
 
See the GNU General Public License for more details.
 
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
*/
// server.h
 
#ifndef SERVER_H
#define SERVER_H
 
typedef struct server_static_s
{
    int maxclients, maxclients_next;
    struct client_s *clients;
    int serverflags;
    qbool changelevel_issued;
    char serverinfo[MAX_SERVERINFO_STRING];
 
    // csqc stuff
    unsigned char *csqc_progdata;
    size_t csqc_progsize_deflated;
    unsigned char *csqc_progdata_deflated;
 
    // independent server thread (when running client)
    qbool threaded; // true if server is running on separate thread
    qbool volatile threadstop;
    void *threadmutex;
    void *thread;
} server_static_t;
 
//=============================================================================
 
typedef enum server_state_e {ss_loading, ss_active} server_state_t;
 
#define MAX_CONNECTFLOODADDRESSES 16
#define MAX_GETSTATUSFLOODADDRESSES 128
typedef struct server_floodaddress_s
{
    double lasttime;
    lhnetaddress_t address;
}
server_floodaddress_t;
 
typedef struct server_s
{
    qbool active;
 
    qbool paused;
    double pausedstart;
    qbool loadgame;
 
    protocolversion_t protocol;
 
    double time;
    double frametime;
 
    unsigned int spawnframe; // signals SV_Frame() to reset its timers
 
    // performance data
    float perf_cpuload;
    float perf_lost;
    float perf_offset_avg;
    float perf_offset_max;
    float perf_offset_sdev;
    // temporary performance data accumulators
    float perf_acc_realtime;
    float perf_acc_sleeptime;
    float perf_acc_lost;
    float perf_acc_offset;
    float perf_acc_offset_squared;
    float perf_acc_offset_max;
    int perf_acc_offset_samples;
 
    // used by PF_checkclient
    int lastcheck;
    double lastchecktime;
 
    // crc of clientside progs at time of level start
    int csqc_progcrc; // -1 = no progs
    int csqc_progsize; // -1 = no progs
    char csqc_progname[MAX_QPATH]; // copied from csqc_progname at level start
 
    world_t world;
 
    // variants of map name
    char worldbasename[MAX_QPATH]; // %s
    char worldname[MAX_QPATH]; // maps/%s.bsp
    char worldnamenoextension[MAX_QPATH]; // maps/%s
    struct model_s *worldmodel;
    // NULL terminated
    // LadyHavoc: precaches are now MAX_QPATH rather than a pointer
    // updated by SV_ModelIndex
    char model_precache[MAX_MODELS][MAX_QPATH];
    struct model_s *models[MAX_MODELS];
    // NULL terminated
    // LadyHavoc: precaches are now MAX_QPATH rather than a pointer
    // updated by SV_SoundIndex
    char sound_precache[MAX_SOUNDS][MAX_QPATH];
    char lightstyles[MAX_LIGHTSTYLES][64];
    server_state_t state;
 
    sizebuf_t datagram;
    unsigned char datagram_buf[NET_MAXMESSAGE];
 
    // copied to all clients at end of frame
    sizebuf_t reliable_datagram;
    unsigned char reliable_datagram_buf[NET_MAXMESSAGE];
 
    sizebuf_t signon;
    unsigned char signon_buf[NET_MAXMESSAGE];
 
    server_floodaddress_t connectfloodaddresses[MAX_CONNECTFLOODADDRESSES];
    server_floodaddress_t getstatusfloodaddresses[MAX_GETSTATUSFLOODADDRESSES];
 
    qbool particleeffectnamesloaded;
    char particleeffectname[MAX_PARTICLEEFFECTNAME][MAX_QPATH];
 
    int writeentitiestoclient_stats_culled_pvs;
    int writeentitiestoclient_stats_culled_trace;
    int writeentitiestoclient_stats_visibleentities;
    int writeentitiestoclient_stats_totalentities;
    int writeentitiestoclient_cliententitynumber;
    int writeentitiestoclient_clientnumber;
    sizebuf_t *writeentitiestoclient_msg;
    vec3_t writeentitiestoclient_eyes[MAX_CLIENTNETWORKEYES];
    int writeentitiestoclient_numeyes;
    unsigned char *writeentitiestoclient_pvs;
    const entity_state_t *writeentitiestoclient_sendstates[MAX_EDICTS];
    unsigned short writeentitiestoclient_csqcsendstates[MAX_EDICTS];
 
    int numsendentities;
    entity_state_t sendentities[MAX_EDICTS];
    entity_state_t *sendentitiesindex[MAX_EDICTS];
 
    int sententitiesmark;
    int sententities[MAX_EDICTS];
    int sententitiesconsideration[MAX_EDICTS];
 
    unsigned char csqcentityversion[MAX_EDICTS]; // legacy
} server_t;
 
#define NUM_CSQCENTITIES_PER_FRAME 256
typedef struct csqcentityframedb_s
{
    int framenum;
    int num;
    unsigned short entno[NUM_CSQCENTITIES_PER_FRAME];
    int sendflags[NUM_CSQCENTITIES_PER_FRAME];
} csqcentityframedb_t;
 
#define NUM_SPAWN_PARMS 16
 
typedef struct client_s
{
    qbool active;
    qbool clientconnectcalled;
    qbool prespawned;
    qbool spawned;
    qbool begun;
    int sendsignon;
 
    int rate;
 
    int rate_burstsize;
 
    double connecttime;
 
    double keepalivetime;
 
    netconn_t *netconnection;
 
    unsigned int movesequence;
    signed char movement_count[NETGRAPH_PACKETS];
    unsigned int movement_highestsequence_seen; // not the same as movesequence if prediction is off
    usercmd_t cmd;
    vec3_t wishdir;
 
    prvm_edict_t *edict;
 
    float ping;
 
    double clmovement_disabletimeout;
    float clmovement_inputtimeout;
 
    prvm_vec_t spawn_parms[NUM_SPAWN_PARMS];
 
    // properties that are sent across the network only when changed
    char name[MAX_SCOREBOARDNAME], old_name[MAX_SCOREBOARDNAME];
    int colors, old_colors;
    int frags, old_frags;
    char playermodel[MAX_QPATH], old_model[MAX_QPATH];
    char playerskin[MAX_QPATH], old_skin[MAX_QPATH];
 
    char netaddress[MAX_QPATH];
 
    float visibletime[MAX_EDICTS];
 
    // scope is whether an entity is currently being networked to this client
    // sendflags is what properties have changed on the entity since the last
    // update that was sent
    int csqcnumedicts;
    unsigned char csqcentityscope[MAX_EDICTS];
    unsigned int csqcentitysendflags[MAX_EDICTS];
 
#define NUM_CSQCENTITYDB_FRAMES 256
    csqcentityframedb_t csqcentityframehistory[NUM_CSQCENTITYDB_FRAMES];
    int csqcentityframehistory_next;
    int csqcentityframe_lastreset;
 
    float nametime;
 
    int latestframenum;
 
    char weaponmodel[MAX_QPATH];
    int weaponmodelindex;
 
    int clientcamera;
 
    entityframe_database_t *entitydatabase;
    entityframe4_database_t *entitydatabase4;
    entityframe5_database_t *entitydatabase5;
 
    // delta compression of stats
    unsigned char statsdeltabits[(MAX_CL_STATS+7)/8];
    int stats[MAX_CL_STATS];
 
    unsigned char unreliablemsg_data[NET_MAXMESSAGE];
    sizebuf_t unreliablemsg;
    int unreliablemsg_splitpoints;
    int unreliablemsg_splitpoint[NET_MAXMESSAGE/16];
 
    // information on an active download if any
    qfile_t *download_file;
    int download_expectedposition; 
    qbool download_started;
    char download_name[MAX_QPATH];
    qbool download_deflate;
 
    // fixangle data
    qbool fixangle_angles_set;
    vec3_t fixangle_angles;
 
    qfile_t *sv_demo_file;
 
    // number of skipped entity frames
    // if it exceeds a limit, an empty entity frame is sent
    int num_skippedentityframes;
 
    // last sent move sequence
    // if the move sequence changed, an empty entity frame is sent
    unsigned int lastmovesequence;
} client_t;
 
 
//=============================================================================
 
// edict->movetype values
#define MOVETYPE_NONE           0       
#define MOVETYPE_ANGLENOCLIP    1
#define MOVETYPE_ANGLECLIP      2
#define MOVETYPE_WALK           3       
#define MOVETYPE_STEP           4       
#define MOVETYPE_FLY            5
#define MOVETYPE_TOSS           6       
#define MOVETYPE_PUSH           7       
#define MOVETYPE_NOCLIP         8
#define MOVETYPE_FLYMISSILE     9       
#define MOVETYPE_BOUNCE         10
#define MOVETYPE_BOUNCEMISSILE  11      
#define MOVETYPE_FOLLOW         12      
#define MOVETYPE_FAKEPUSH       13      
#define MOVETYPE_PHYSICS        32      
#define MOVETYPE_FLY_WORLDONLY      33      
#define MOVETYPE_USER_FIRST     128     
#define MOVETYPE_USER_LAST      191
 
// edict->solid values
#define SOLID_NOT               0       
#define SOLID_TRIGGER           1       
#define SOLID_BBOX              2       
#define SOLID_SLIDEBOX          3       
#define SOLID_BSP               4       
// LadyHavoc: corpse code
#define SOLID_CORPSE            5       
// LadyHavoc: physics
// VorteX: now these fields are deprecated, as geomtype is more flexible
#define SOLID_PHYSICS_BOX       32      
#define SOLID_PHYSICS_SPHERE    33      
#define SOLID_PHYSICS_CAPSULE   34      
#define SOLID_PHYSICS_TRIMESH   35      
#define SOLID_PHYSICS_CYLINDER  36      
 
// edict->deadflag values
#define DEAD_NO                 0
#define DEAD_DYING              1
#define DEAD_DEAD               2
 
#define DAMAGE_NO               0
#define DAMAGE_YES              1
#define DAMAGE_AIM              2
 
// edict->flags
#define FL_FLY                  1
#define FL_SWIM                 2
#define FL_CONVEYOR             4
#define FL_CLIENT               8
#define FL_INWATER              16
#define FL_MONSTER              32      
#define FL_GODMODE              64
#define FL_NOTARGET             128
#define FL_ITEM                 256
#define FL_ONGROUND             512
#define FL_PARTIALGROUND        1024    
#define FL_WATERJUMP            2048    
#define FL_JUMPRELEASED         4096    
 
#define SPAWNFLAG_NOT_EASY          256
#define SPAWNFLAG_NOT_MEDIUM        512
#define SPAWNFLAG_NOT_HARD          1024
#define SPAWNFLAG_NOT_DEATHMATCH    2048
 
//============================================================================
 
extern cvar_t coop;
extern cvar_t deathmatch;
extern cvar_t fraglimit;
extern cvar_t gamecfg;
extern cvar_t noexit;
extern cvar_t nomonsters;
extern cvar_t pausable;
extern cvar_t pr_checkextension;
extern cvar_t samelevel;
extern cvar_t saved1;
extern cvar_t saved2;
extern cvar_t saved3;
extern cvar_t saved4;
extern cvar_t savedgamecfg;
extern cvar_t scratch1;
extern cvar_t scratch2;
extern cvar_t scratch3;
extern cvar_t scratch4;
extern cvar_t skill;
extern cvar_t host_timescale;
extern cvar_t sv_accelerate;
extern cvar_t sv_aim;
extern cvar_t sv_airaccel_qw;
extern cvar_t sv_airaccel_sideways_friction;
extern cvar_t sv_airaccelerate;
extern cvar_t sv_airstopaccelerate;
extern cvar_t sv_airstrafeaccelerate;
extern cvar_t sv_maxairstrafespeed;
extern cvar_t sv_airstrafeaccel_qw;
extern cvar_t sv_aircontrol;
extern cvar_t sv_aircontrol_power;
extern cvar_t sv_aircontrol_penalty;
extern cvar_t sv_airspeedlimit_nonqw;
extern cvar_t sv_allowdownloads;
extern cvar_t sv_allowdownloads_archive;
extern cvar_t sv_allowdownloads_config;
extern cvar_t sv_allowdownloads_dlcache;
extern cvar_t sv_allowdownloads_inarchive;
extern cvar_t sv_areagrid_link_SOLID_NOT;
extern cvar_t sv_areagrid_mingridsize;
extern cvar_t sv_checkforpacketsduringsleep;
extern cvar_t sv_clmovement_enable;
extern cvar_t sv_clmovement_minping;
extern cvar_t sv_clmovement_minping_disabletime;
extern cvar_t sv_clmovement_inputtimeout;
extern cvar_t sv_clmovement_maxnetfps;
extern cvar_t sv_cullentities_nevercullbmodels;
extern cvar_t sv_cullentities_pvs;
extern cvar_t sv_cullentities_stats;
extern cvar_t sv_cullentities_trace;
extern cvar_t sv_cullentities_trace_delay;
extern cvar_t sv_cullentities_trace_enlarge;
extern cvar_t sv_cullentities_trace_prediction;
extern cvar_t sv_cullentities_trace_samples;
extern cvar_t sv_cullentities_trace_samples_extra;
extern cvar_t sv_debugmove;
extern cvar_t sv_echobprint;
extern cvar_t sv_edgefriction;
extern cvar_t sv_entpatch;
extern cvar_t sv_freezenonclients;
extern cvar_t sv_friction;
extern cvar_t sv_gameplayfix_blowupfallenzombies;
extern cvar_t sv_gameplayfix_consistentplayerprethink;
extern cvar_t sv_gameplayfix_delayprojectiles;
extern cvar_t sv_gameplayfix_droptofloorstartsolid;
extern cvar_t sv_gameplayfix_droptofloorstartsolid_nudgetocorrect;
extern cvar_t sv_gameplayfix_easierwaterjump;
extern cvar_t sv_gameplayfix_findradiusdistancetobox;
extern cvar_t sv_gameplayfix_gravityunaffectedbyticrate;
extern cvar_t sv_gameplayfix_grenadebouncedownslopes;
extern cvar_t sv_gameplayfix_impactbeforeonground;
extern cvar_t sv_gameplayfix_multiplethinksperframe;
extern cvar_t sv_gameplayfix_noairborncorpse;
extern cvar_t sv_gameplayfix_noairborncorpse_allowsuspendeditems;
extern cvar_t sv_gameplayfix_nudgeoutofsolid;
extern cvar_t sv_gameplayfix_nudgeoutofsolid_separation;
extern cvar_t sv_gameplayfix_q2airaccelerate;
extern cvar_t sv_gameplayfix_nogravityonground;
extern cvar_t sv_gameplayfix_setmodelrealbox;
extern cvar_t sv_gameplayfix_slidemoveprojectiles;
extern cvar_t sv_gameplayfix_stepdown;
extern cvar_t sv_gameplayfix_stepmultipletimes;
extern cvar_t sv_gameplayfix_nostepmoveonsteepslopes;
extern cvar_t sv_gameplayfix_swiminbmodels;
extern cvar_t sv_gameplayfix_upwardvelocityclearsongroundflag;
extern cvar_t sv_gameplayfix_downtracesupportsongroundflag;
extern cvar_t sv_gameplayfix_q1bsptracelinereportstexture;
extern cvar_t sv_gameplayfix_unstickplayers;
extern cvar_t sv_gameplayfix_unstickentities;
extern cvar_t sv_gameplayfix_fixedcheckwatertransition;
extern cvar_t sv_gameplayfix_nosquashentities;
extern cvar_t sv_gravity;
extern cvar_t sv_idealpitchscale;
extern cvar_t sv_jumpstep;
extern cvar_t sv_jumpvelocity;
extern cvar_t sv_legacy_bbox_expand;
extern cvar_t sv_maxairspeed;
extern cvar_t sv_maxrate;
extern cvar_t sv_maxspeed;
extern cvar_t sv_maxvelocity;
extern cvar_t sv_nostep;
extern cvar_t sv_playerphysicsqc;
extern cvar_t sv_progs;
extern cvar_t sv_protocolname;
extern cvar_t sv_random_seed;
extern cvar_t host_limitlocal;
extern cvar_t sv_sound_land;
extern cvar_t sv_sound_watersplash;
extern cvar_t sv_stepheight;
extern cvar_t sv_stopspeed;
extern cvar_t sv_wallfriction;
extern cvar_t sv_wateraccelerate;
extern cvar_t sv_waterfriction;
extern cvar_t sv_areadebug;
extern cvar_t sys_ticrate;
extern cvar_t teamplay;
extern cvar_t temp1;
extern cvar_t timelimit;
 
extern mempool_t *sv_mempool;
 
extern server_static_t svs;
extern server_t sv;
 
extern client_t *host_client;
 
//===========================================================
 
void SV_Init (void);
double SV_Frame(double time);
void SV_Shutdown(void);
 
int SV_IsLocalServer(void);
 
void SV_StartParticle (vec3_t org, vec3_t dir, int color, int count);
void SV_StartEffect (vec3_t org, int modelindex, int startframe, int framecount, int framerate);
void SV_StartSound (prvm_edict_t *entity, int channel, const char *sample, int volume, float attenuation, qbool reliable, float speed);
void SV_StartPointSound (vec3_t origin, const char *sample, int volume, float attenuation, float speed);
 
void SV_ConnectClient (int clientnum, netconn_t *netconnection);
void SV_DropClient (qbool leaving, const char *reason, ... );
 
void SV_ClientCommands(const char *fmt, ...) DP_FUNC_PRINTF(1);
 
void SV_SendClientMessages(void);
 
void SV_ReadClientMessage(void);
 
// precachemode values:
// 0 = fail if not precached,
// 1 = warn if not found and precache if possible
// 2 = precache
int SV_ModelIndex(const char *s, int precachemode);
int SV_SoundIndex(const char *s, int precachemode);
 
int SV_ParticleEffectIndex(const char *name);
 
model_t *SV_GetModelByIndex(int modelindex);
model_t *SV_GetModelFromEdict(prvm_edict_t *ed);
 
void SV_SetIdealPitch (void);
 
void SV_AddUpdates (void);
 
void SV_PlayerPhysics (void);
 
void SV_ClientPrint(const char *msg);
void SV_ClientPrintf(const char *fmt, ...) DP_FUNC_PRINTF(1);
void SV_BroadcastPrint(const char *msg);
void SV_BroadcastPrintf(const char *fmt, ...) DP_FUNC_PRINTF(1);
 
void SV_Physics (void);
void SV_Physics_ClientMove (void);
//void SV_Physics_ClientEntity (prvm_edict_t *ent);
 
qbool SV_PlayerCheckGround (prvm_edict_t *ent);
qbool SV_CheckBottom (prvm_edict_t *ent);
qbool SV_movestep (prvm_edict_t *ent, vec3_t move, qbool relink, qbool noenemy, qbool settrace);
 
void SV_LinkEdict(prvm_edict_t *ent);
void SV_LinkEdict_TouchAreaGrid(prvm_edict_t *ent);
void SV_LinkEdict_TouchAreaGrid_Call(prvm_edict_t *touch, prvm_edict_t *ent); // if we detected a touch from another source
 
int SV_GenericHitSuperContentsMask(const prvm_edict_t *edict);
trace_t SV_TraceBox(const vec3_t start, const vec3_t mins, const vec3_t maxs, const vec3_t end, int type, prvm_edict_t *passedict, int hitsupercontentsmask, int skipsupercontentsmask, int skipmaterialflagsmask, float extend);
trace_t SV_TraceLine(const vec3_t start, const vec3_t end, int type, prvm_edict_t *passedict, int hitsupercontentsmask, int skipsupercontentsmask, int skipmaterialflagsmask, float extend);
trace_t SV_TracePoint(const vec3_t start, int type, prvm_edict_t *passedict, int hitsupercontentsmask, int skipsupercontentsmask, int skipmaterialflagsmask);
int SV_EntitiesInBox(const vec3_t mins, const vec3_t maxs, int maxedicts, prvm_edict_t **resultedicts);
 
qbool SV_CanSeeBox(int numsamples, vec_t eyejitter, vec_t enlarge, vec_t entboxexpand, vec3_t eye, vec3_t entboxmins, vec3_t entboxmaxs);
 
void SV_MarkWriteEntityStateToClient(entity_state_t *s, client_t *client);
 
void SV_SendServerinfo(client_t *client);
void SV_WriteEntitiesToClient(client_t *client, prvm_edict_t *clent, sizebuf_t *msg, int maxsize);
void SV_AddCameraEyes(void);
 
int SV_PointSuperContents(const vec3_t point);
 
void SV_FlushBroadcastMessages(void);
void SV_WriteClientdataToMessage (client_t *client, prvm_edict_t *ent, sizebuf_t *msg, int *stats);
 
void VM_SV_MoveToGoal(prvm_prog_t *prog);
 
void SV_ApplyClientMove (void);
void SV_SaveSpawnparms (void);
 
void SV_SpawnServer (const char *map);
 
void SV_CheckVelocity (prvm_edict_t *ent);
 
void SV_SetupVM(void);
 
const char *SV_TimingReport(char *buf, size_t buflen); 
 
int SV_GetPitchSign(prvm_prog_t *prog, prvm_edict_t *ent);
void SV_GetEntityMatrix(prvm_prog_t *prog, prvm_edict_t *ent, matrix4x4_t *out, qbool viewmatrix);
 
void SV_StartThread(void);
void SV_StopThread(void);
#define SV_LockThreadMutex() (void)(svs.threaded ? Thread_LockMutex(svs.threadmutex) : 0)
#define SV_UnlockThreadMutex() (void)(svs.threaded ? Thread_UnlockMutex(svs.threadmutex) : 0)
 
void VM_CustomStats_Clear(void);
void VM_SV_UpdateCustomStats(client_t *client, prvm_edict_t *ent, sizebuf_t *msg, int *stats);
void SV_Name(int clientnum);
void SV_InitOperatorCommands(void);
 
void SV_Savegame_to(prvm_prog_t *prog, const char *name);
void SV_Savegame_f(cmd_state_t *cmd);
void SV_Loadgame_f(cmd_state_t *cmd);
 
void SV_PreSpawn_f(cmd_state_t *cmd);
void SV_Spawn_f(cmd_state_t *cmd);
void SV_Begin_f(cmd_state_t *cmd);
 
qbool SV_VM_ConsoleCommand(const char *text, size_t textlen);
 
#endif