server.h

Go to the documentation of this file.

/*
All original material Copyright (C) 2002-2023 UFO: Alien Invasion.

Original file from Quake 2 v3.21: quake2-2.31/server/server.h
Copyright (C) 1997-2001 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.

*/

#pragma once

#include "../common/common.h"
#include "../common/http.h"
#include "../shared/infostring.h"
#include "../game/game.h"
#include <SDL_thread.h>

extern memPool_t* sv_genericPool;

typedef struct sv_edict_s {
    struct worldSector_s* worldSector;  
    struct sv_edict_s* nextEntityInWorldSector;
    bool linked;        
    edict_t* ent;
} sv_edict_t;

typedef struct sv_model_s {
    AABB aabb;          
    int frame;          
    char* name;         
} sv_model_t;

typedef struct worldSector_s {
    int axis;                   
    float dist;
    struct worldSector_s* children[2];
    sv_edict_t* entities;
} worldSector_t;

#define AREA_NODES  32

typedef struct pending_event_s {
    bool pending;
    int playerMask;
    int type;
    int entnum;
    dbuffer* buf;
} pending_event_t;

typedef struct serverInstanceStatic_s {
    bool initialized;           
    int realtime;               
    struct datagram_socket* netDatagramSocket;
    struct client_s* clients;   
    int lastHeartbeat;          
    int lastPing;
    bool abandon;               
    bool killserver;            
    SDL_mutex* serverMutex;
    SDL_cond* gameFrameCond;    
    SDL_Thread* gameThread;
#ifndef HARD_LINKED_GAME
    void* gameLibrary;
#endif
    game_export_t* ge;
} serverInstanceStatic_t;

typedef enum server_state_e {
    ss_dead,                    
    ss_restart,                 
    ss_loading,                 
    ss_game,                    
    ss_game_shutdown            
} server_state_t;

typedef struct serverInstanceGame_s {
    server_state_t state;       
    char name[MAX_QPATH];       
    char assembly[MAX_QPATH];   
    struct cBspModel_s* models[MAX_MODELS];

    bool endgame;
    bool spawned;               
    bool started;               
    char configstrings[MAX_CONFIGSTRINGS][MAX_TOKEN_CHARS];

    dbuffer* messageBuffer;     
    pending_event_t pendingEvent;
    pending_event_t eventQueue[64];
    int eventQueuePos;

    mapData_t mapData;

    mapTiles_t mapTiles;

    sv_model_t svModels[MAX_MOD_KNOWN];
    unsigned int numSVModels;
    sv_edict_t edicts[MAX_EDICTS];
    worldSector_t worldSectors[AREA_NODES];
    unsigned int numWorldSectors;

    memPool_t* gameSysPool;     
} serverInstanceGame_t;

#define PLAYER_NUM(n) ((player_t*)((byte*)svs.ge->players + svs.ge->player_size * (n)))

typedef enum {
    cs_free,                    
    cs_connected,               
    cs_spawning,                
    cs_began,                   
    cs_spawned                  
} client_state_t;

typedef struct client_s {
    client_state_t state;
    char userinfo[MAX_INFO_STRING];
    player_t* player;           
    char name[32];              
    int messagelevel;           
    int lastmessage;            
    char peername[256];
    struct net_stream* stream;
} client_t;

extern serverInstanceStatic_t svs;  
extern serverInstanceGame_t* sv;    
extern cvar_t* sv_mapname;
extern cvar_t* sv_rma;
extern cvar_t* sv_rmadisplaythemap;
extern cvar_t* sv_public;           
extern cvar_t* sv_dumpmapassembly;
extern cvar_t* sv_threads;          
/* sv_main.c */
void SV_DropClient(client_t* drop, const char* message);
int SV_CountPlayers(void);
void SV_InitOperatorCommands(void);
void SV_UserinfoChanged(client_t* cl);
void SV_ReadPacket(struct net_stream* s);
char* SV_GetConfigString(int index);
int SV_GetConfigStringLength(int index);
int SV_GetConfigStringInteger(int index);
char* SV_SetConfigString(int index, ...);
/* ensure that always two parameters are used */
#define SV_SetConfigString(index, value) SV_SetConfigString(index, value)
client_t* SV_GetNextClient(client_t* lastClient);
client_t* SV_GetClient(int index);

/* sv_mapcycle.c */
void SV_MapcycleInit(void);
void SV_NextMapcycle(void);
void SV_MapcycleClear(void);

/* sv_init.c */
void SV_Map(bool day, const char* levelstring, const char* assembly, bool verbose = true);

void SV_Multicast(int mask, const dbuffer& msg);
void SV_ClientCommand(client_t* client, const char* fmt, ...) __attribute__((format(__printf__,2,3)));
void SV_ClientPrintf(client_t* cl, int level, const char* fmt, ...) __attribute__((format(__printf__,3,4)));
void SV_BroadcastPrintf(int level, const char* fmt, ...) __attribute__((format(__printf__,2,3)));

/* sv_user.c */
void SV_ExecuteClientMessage(client_t* cl, int cmd, dbuffer* msg);
void SV_SetClientState(client_t* client, client_state_t state);

/* sv_ccmds.c */
void SV_SetMaster_f(void);
void SV_Heartbeat_f(void);
bool SV_CheckMap(const char* map, const char* assembly);

/* sv_game.c */
int SV_RunGameFrameThread(void* data);
void SV_RunGameFrame(void);
void SV_InitGameProgs(void);
void SV_ShutdownGameProgs(void);

/*============================================================ */

void SV_ClearWorld(void);

void SV_UnlinkEdict(edict_t* ent);
void SV_LinkEdict(edict_t* ent);

/*=================================================================== */

/* returns the CONTENTS_* value from the world at the given point. */
int SV_PointContents(const vec3_t p);
const char* SV_GetFootstepSound(const char* texture);
float SV_GetBounceFraction(const char* texture);
bool SV_LoadModelAABB(const char* model, int frame, AABB& aabb);
trace_t SV_Trace(const Line& traceLine, const AABB& box, const edict_t* passedict, int contentmask);
server_state_t SV_GetServerState(void);
void SV_SetServerState(server_state_t);