#include "util.qh"

Include dependency graph for mapinfo.qh:

This graph shows which files directly or indirectly include this file:

Classes
class	Gametype

Macros
#define	MAPINFO_SETTEMP_ACL_SYSTEM "-g_mapinfo_* -rcon_* -_* -g_ban* +*"
#define	MAPINFO_SETTEMP_ACL_USER cvar_string("g_mapinfo_settemp_acl")
#define	REGISTER_GAMETYPE(NAME, inst)

Functions
vector	_GametypeFlags_FromGametype (int a)
float	_MapInfo_FilterGametype (vector gametypeFlags, float features, float pFlagsRequired, float pFlagsForbidden, float pAbortOnGenerate)
string	_MapInfo_FindArenaFile (string pFilename, string extension)
string	_MapInfo_GetDefaultEx (Gametype t)
float	_MapInfo_GetTeamPlayBool (Gametype t)
void	_MapInfo_Parse_Settemp (string pFilename, string acl, float type, string s, float recurse)
bool	_MapInfo_ParseArena (string arena_filename, int fh, string pFilename, Gametype pGametypeToSet, bool isdefi, bool isgenerator)
string	MapInfo_BSPName_ByID (float i)
void	MapInfo_Cache_Create ()
void	MapInfo_Cache_Destroy ()
void	MapInfo_Cache_Invalidate ()
float	MapInfo_CheckMap (string s)
void	MapInfo_ClearTemps ()
int	MapInfo_CurrentFeatures ()
Gametype	MapInfo_CurrentGametype ()
void	MapInfo_Enumerate ()
float	MapInfo_FilterGametype (Gametype gametypeFlags, float features, float pFlagsRequired, float pFlagsForbidden, float pAbortOnGenerate)
void	MapInfo_FilterString (string sf)
float	MapInfo_FindName (string s)
string	MapInfo_FixName (string s)
int	MapInfo_ForbiddenFlags ()
bool	MapInfo_Get_ByID (int i)
int	MapInfo_Get_ByName (string s, float allowGenerate, Gametype gametypeToSet)
string	MapInfo_ListAllAllowedMaps (float pFlagsRequired, float pFlagsForbidden)
string	MapInfo_ListAllowedMaps (Gametype type, float pFlagsRequired, float pFlagsForbidden)
void	MapInfo_LoadMap (string s, float reinit)
void	MapInfo_LoadMapSettings (string s)
int	MapInfo_RequiredFlags ()
void	MapInfo_Shutdown ()
void	MapInfo_SwitchGameType (Gametype t)
string	MapInfo_Type_Description (Gametype t)
Gametype	MapInfo_Type_FromString (string t, bool dowarn, bool is_q3compat)
string	MapInfo_Type_ToString (Gametype t)
string	MapInfo_Type_ToText (Gametype t)
bool	MapReadSizes (string map)
	STATIC_INIT (Gametypes_renumber)

Variables
const int	GAMETYPE_FLAG_1V1 = BIT(6)
const int	GAMETYPE_FLAG_HIDELIMITS = BIT(4)
const int	GAMETYPE_FLAG_PREFERRED = BIT(2)
const int	GAMETYPE_FLAG_PRIORITY = BIT(3)
const int	GAMETYPE_FLAG_TEAMPLAY = BIT(0)
const int	GAMETYPE_FLAG_USEPOINTS = BIT(1)
const int	GAMETYPE_FLAG_WEAPONARENA = BIT(5)
vector	gametype_flags
int	map_maxplayers
int	map_minplayers
float	MapInfo_count
const int	MAPINFO_FEATURE_MONSTERS = 8
const int	MAPINFO_FEATURE_TURRETS = 4
const int	MAPINFO_FEATURE_VEHICLES = 2
const int	MAPINFO_FEATURE_WEAPONS = 1
float	MapInfo_FindName_firstResult
string	MapInfo_FindName_match
const int	MAPINFO_FLAG_DONOTWANT = 8
const int	MAPINFO_FLAG_FORBIDDEN = 2
const int	MAPINFO_FLAG_FRUSTRATING = 4
const int	MAPINFO_FLAG_HIDDEN = 1
Gametype	MapInfo_LoadedGametype
string	MapInfo_Map_author
string	MapInfo_Map_bspname
string	MapInfo_Map_clientstuff
string	MapInfo_Map_description
int	MapInfo_Map_flags
string	MapInfo_Map_fog
vector	MapInfo_Map_maxs
vector	MapInfo_Map_mins
int	MapInfo_Map_supportedFeatures
vector	MapInfo_Map_supportedGametypes
string	MapInfo_Map_title
string	MapInfo_Map_titlestring
float	MapInfo_progress
vector	MAPINFO_TYPE_ALL

Macro Definition Documentation

◆ MAPINFO_SETTEMP_ACL_SYSTEM

#define MAPINFO_SETTEMP_ACL_SYSTEM "-g_mapinfo_* -rcon_* -_* -g_ban* +*"

Definition at line 237 of file mapinfo.qh.

Referenced by _MapInfo_Parse_Settemp().

◆ MAPINFO_SETTEMP_ACL_USER

#define MAPINFO_SETTEMP_ACL_USER cvar_string("g_mapinfo_settemp_acl")

Definition at line 236 of file mapinfo.qh.

Referenced by CampaignPreInit(), and MapInfo_Get_ByName_NoFallbacks().

◆ REGISTER_GAMETYPE

#define REGISTER_GAMETYPE	(		NAME,
			inst )

Value:

REGISTER(Gametypes, MAPINFO_TYPE, NAME, m_id, inst)

m_id

int m_id

Definition effect.qh:19

REGISTER

#define REGISTER(...)

Register a new entity with a registry.

Definition registry.qh:87

Definition at line 149 of file mapinfo.qh.

Referenced by REGISTER_GAMETYPE(), REGISTER_GAMETYPE(), REGISTER_GAMETYPE(), REGISTER_GAMETYPE(), REGISTER_GAMETYPE(), REGISTER_GAMETYPE(), REGISTER_GAMETYPE(), REGISTER_GAMETYPE(), REGISTER_GAMETYPE(), REGISTER_GAMETYPE(), REGISTER_GAMETYPE(), REGISTER_GAMETYPE(), REGISTER_GAMETYPE(), REGISTER_GAMETYPE(), REGISTER_GAMETYPE(), REGISTER_GAMETYPE(), REGISTER_GAMETYPE(), REGISTER_GAMETYPE(), REGISTER_GAMETYPE(), and REGISTER_GAMETYPE().

Function Documentation

◆ _GametypeFlags_FromGametype()

vector _GametypeFlags_FromGametype ( int a )

Definition at line 20 of file mapinfo.qc.

{
    if (REGISTRY_MAX(Gametypes) > 24)
        if (a >= 24)
        {
            a -= 24;
            if (REGISTRY_MAX(Gametypes) > 48)
                if (a >= 24)
                {
                    a -= 24;
                    return '0 0 1' * BIT(a);
                }
            return '0 1 0' * BIT(a);
        }
    return '1 0 0' * BIT(a);
}

References BIT, REGISTRY_MAX, and vector.

Referenced by STATIC_INIT().

◆ _MapInfo_FilterGametype()

float _MapInfo_FilterGametype	(	vector	gametypeFlags,
		float	features,
		float	pFlagsRequired,
		float	pFlagsForbidden,
		float	pAbortOnGenerate )

References vector.

◆ _MapInfo_FindArenaFile()

string _MapInfo_FindArenaFile	(	string	pFilename,
		string	extension )

Definition at line 1008 of file mapinfo.qc.

{
    // A valid arena file with the "default" name may have been created as a map-specific
    // override of an arena file with a different name (possibly multi-map) in the pk3
    // (occasionally in the wild such file exists in the pk3 but isn't valid for a map in the pk3).
    // Therefore we try the "default" name first.
    string afile = _MapInfo_CheckArenaFile(strcat("scripts/", pFilename, extension), pFilename);
    if (afile != ""
    || !checkextension("DP_QC_FS_SEARCH_PACKFILE"))
        return afile;
 
    string base_pack = whichpack(strcat("maps/", pFilename, ".bsp"));
    if(base_pack == "") // this map isn't packaged!
        return "";
    int glob = search_packfile_begin(strcat("scripts/*", extension), true, true, base_pack);
    if(glob < 0) // there's no matching file in the pack
        return "";
    int n = search_getsize(glob);
    for(int j = 0; j < n; ++j)
    {
        afile = search_getfilename(glob, j);
        if(_MapInfo_CheckArenaFile(afile, pFilename) != "")
        {
            search_end(glob);
            return afile;
        }
    }
    search_end(glob);
 
    return ""; // if we get here, a valid .arena file could not be found
}

References _MapInfo_CheckArenaFile(), checkextension(), search_end(), search_getfilename(), search_getsize(), and strcat().

Referenced by _MapInfo_Generate(), MapInfo_Get_ByName_NoFallbacks(), and spawnfunc().

◆ _MapInfo_GetDefaultEx()

string _MapInfo_GetDefaultEx ( Gametype t )

Definition at line 534 of file mapinfo.qc.

{
    return t ? t.model2 : "";
}

Referenced by _MapInfo_Map_ApplyGametypeEx().

◆ _MapInfo_GetTeamPlayBool()

float _MapInfo_GetTeamPlayBool ( Gametype t )

Definition at line 539 of file mapinfo.qc.

{
    return t ? t.team : false;
}

References Gametype::team.

Referenced by MapHasRightSize(), NET_HANDLE(), and XonoticGametypeList_drawListBoxItem().

◆ _MapInfo_Parse_Settemp()

void _MapInfo_Parse_Settemp	(	string	pFilename,
		string	acl,
		float	type,
		string	s,
		float	recurse )

Definition at line 667 of file mapinfo.qc.

{
    string t;
    float o;
    // tabs are invalid, treat them as "empty"
    s = strreplace("\t", "", s);
 
    t = car(s); s = cdr(s);
 
    // limited support of "" and comments
    //   remove trailing and leading " of t
    if(substring(t, 0, 1) == "\"")
    {
        if(substring(t, -1, 1) == "\"")
            t = substring(t, 1, -2);
    }
 
    //   remove leading " of s
    if(substring(s, 0, 1) == "\"")
    {
        s = substring(s, 1, -1);
    }
    //   remove trailing " of s, and all that follows (cvar description)
    o = strstrofs(s, "\"", 0);
    if(o >= 0)
        s = substring(s, 0, o);
 
    //   remove // comments
    o = strstrofs(s, "//", 0);
    if(o >= 0)
        s = substring(s, 0, o);
 
    //   remove trailing spaces
    while(substring(s, -1, 1) == " ")
        s = substring(s, 0, -2);
 
    if(t == "#include")
    {
        if(recurse > 0)
        {
            float fh = fopen(s, FILE_READ);
            if(fh < 0)
            {
                if(WARN_COND)
                    LOG_WARN("Map ", pFilename, " references not existing config file ", s);
            }
            else
            {
                while((s = fgets(fh)))
                {
                    s = strreplace("\t", "", s); // treat tabs as "empty", perform here first to ensure coments are detected
                    // catch different sorts of comments
                    if(s == "")                    // empty lines
                        continue;
                    if(substring(s, 0, 1) == "#")  // UNIX style
                        continue;
                    if(substring(s, 0, 2) == "//") // C++ style
                        continue;
                    if(substring(s, 0, 1) == "_")  // q3map style
                        continue;
 
                    if(substring(s, 0, 4) == "set ")
                        s = substring(s, 4, -1);
                    if(substring(s, 0, 5) == "seta ")
                        s = substring(s, 5, -1);
 
                    _MapInfo_Parse_Settemp(pFilename, acl, type, s, recurse - 1);
                }
                fclose(fh);
            }
        }
        else if(WARN_COND)
            LOG_WARN("Map ", pFilename, " uses too many levels of inclusion");
    }
    else if(t == ""
        || !cvar_value_issafe(t)
        || !cvar_value_issafe(s)
        || matchacl(MAPINFO_SETTEMP_ACL_SYSTEM, t) <= 0)
    {
        if (WARN_COND)
            LOG_WARN("Map ", pFilename, " contains a potentially harmful setting, ignored");
    }
    else if(matchacl(acl, t) <= 0)
    {
        if (WARN_COND)
            LOG_WARN("Map ", pFilename, " contains a denied setting, ignored");
    }
    else
    {
        if(type == 0) // server set
        {
            LOG_TRACE("Applying temporary setting ", t, " := ", s);
        #if 0
            if(cvar("g_campaign"))
                cvar_set(t, s); // this is a wrapper and is always temporary anyway; no need to backup old values then
            else
        #endif
                cvar_settemp(t, s);
        }
        else
        {
            LOG_TRACE("Applying temporary client setting ", t, " := ", s);
            MapInfo_Map_clientstuff = strcat(
                    MapInfo_Map_clientstuff, "cl_cmd settemp \"", t, "\" \"", s, "\"\n"
                    );
        }
    }
}

References _MapInfo_Parse_Settemp(), car(), cdr(), cvar(), cvar_set(), cvar_settemp(), cvar_value_issafe(), fclose(), fgets(), FILE_READ, fopen(), LOG_TRACE, LOG_WARN, MapInfo_Map_clientstuff, MAPINFO_SETTEMP_ACL_SYSTEM, matchacl(), strcat(), strstrofs, substring(), and WARN_COND.

Referenced by _MapInfo_Parse_Settemp(), CampaignPreInit(), and MapInfo_Get_ByName_NoFallbacks().

◆ _MapInfo_ParseArena()

bool _MapInfo_ParseArena	(	string	arena_filename,
		int	fh,
		string	pFilename,
		Gametype	pGametypeToSet,
		bool	isdefi,
		bool	isgenerator )

Definition at line 826 of file mapinfo.qc.

{
    // NOTE: .arena files can hold more than 1 map's information!
    // to handle this, we're going to store gathered information in local variables and save it if we encounter the correct map name
    bool in_brackets = false; // testing a potential mapinfo section (within brackets)
    bool dosave = false;
    string stored_Map_description = "";
    string stored_Map_title = "";
    string stored_Map_author = "";
    vector stored_supportedGametypes = '0 0 0';
    int stored_supportedFeatures = 0;
    int stored_flags = 0;
    string t, s;
 
    if (isgenerator)
        LOG_INFO("Generating ", pFilename, ".mapinfo: analyzing ", arena_filename);
 
    for (;;)
    {
        if (!((s = fgets(fh))))
            break;
 
        // catch different sorts of comments
        if(s == "")                    // empty lines
            continue;
        if(substring(s, 0, 2) == "//") // C++ style
            continue;
        if(strstrofs(s, "{", 0) >= 0)
        {
            if(in_brackets)
                return false; // edge case? already in a bracketed section!
            in_brackets = true;
            continue;
        }
        else if(!in_brackets)
        {
            // if we're not inside a bracket, don't process map info
            continue;
        }
        if(strstrofs(s, "}", 0) >= 0)
        {
            if(!in_brackets)
                return false; // no starting bracket! let the mapinfo generation system handle it
            in_brackets = false;
            if(dosave)
            {
                MapInfo_Map_description = stored_Map_description;
                if(stored_Map_title != "")
                    MapInfo_Map_title = stored_Map_title;
                if(stored_Map_author != "") // write the usual "<AUTHOR>" if we have nothing better
                    MapInfo_Map_author = stored_Map_author;
                // might have .arena AND .defi for the same map so these bitfields are OR'd
                if(isgenerator)
                    MapInfo_Map_supportedGametypes |= stored_supportedGametypes;
                else
                {
                    FOREACH(Gametypes, it.gametype_flags & stored_supportedGametypes,
                    {
                        _MapInfo_Map_ApplyGametype ("", pGametypeToSet, it, true);
                    });
                }
                MapInfo_Map_supportedFeatures |= stored_supportedFeatures;
                MapInfo_Map_flags |= stored_flags;
                return true; // no need to continue through the file, we have our map!
            }
            else
            {
                // discard any gathered locals, we're not using the correct map!
                stored_Map_description = "";
                stored_Map_title = "";
                stored_Map_author = "";
                stored_supportedGametypes = '0 0 0';
                stored_supportedFeatures = 0;
                stored_flags = 0;
                continue;
            }
        }
 
        s = strreplace("\t", " ", s);
 
        float p = strstrofs(s, "//", 0);
        if(p >= 0)
            s = substring(s, 0, p);
 
        // perform an initial trim to ensure the first argument is properly obtained
        //   remove leading spaces
        while(substring(s, 0, 1) == " ")
            s = substring(s, 1, -1);
 
        t = car(s); s = cdr(s);
        t = strtolower(t); // apparently some q3 maps use capitalized parameters
 
        //   remove trailing spaces
        while(substring(t, -1, 1) == " ")
            t = substring(t, 0, -2);
 
        //   remove trailing spaces
        while(substring(s, -1, 1) == " ")
            s = substring(s, 0, -2);
        //   remove leading spaces
        while(substring(s, 0, 1) == " ")
            s = substring(s, 1, -1);
        // limited support of ""
        //   remove trailing and leading " of s
        if(substring(s, 0, 1) == "\"")
        {
            if(substring(s, -1, 1) == "\"")
                s = substring(s, 1, -2);
        }
        if(t == "longname")
            stored_Map_title = s;
        else if(t == "author")
            stored_Map_author = s;
        else if(t == "type")
        {
            // if there is a valid gametype in this .arena file, include it in the menu
            stored_supportedFeatures |= MAPINFO_FEATURE_WEAPONS;
            // type in quake 3 holds all the supported gametypes, so we must loop through all of them
            // TODO: handle support here better to include more Xonotic teamplay modes
            string types = s;
            types = strreplace("team", "tdm ft", types);
            types = strreplace("ffa", "dm lms ka", types);
            types = strreplace("tourney", "duel", types); // QL used duel so the following check must support it
            if(strstrofs(types, "duel", 0) < 0 && strstrofs(types, "tdm", 0) >= 0) // larger team map, support additional gametypes!
                types = cons(types, "ca kh");
            FOREACH_WORD(types, true,
            {
                Gametype f = MapInfo_Type_FromString(it, false, true);
                if(f)
                    stored_supportedGametypes |= f.gametype_flags;
            });
        }
        else if(t == "style" && isdefi)
        {
            // we have a defrag map on our hands, add CTS!
            // TODO: styles
            stored_supportedGametypes |= MAPINFO_TYPE_CTS.gametype_flags;
        }
        else if(t == "map")
        {
            if(strtolower(s) == strtolower(pFilename))
                dosave = true; // yay, found our map!
        }
        else if(t == "quote")
            stored_Map_description = s;
        // TODO: fraglimit
    }
 
    // if the map wasn't found in the .arena, fall back to generated .mapinfo
    return false;
}

References car(), cdr(), cons(), fgets(), FOREACH, FOREACH_WORD, LOG_INFO, MAPINFO_FEATURE_WEAPONS, MapInfo_Map_author, MapInfo_Map_description, MapInfo_Map_flags, MapInfo_Map_supportedFeatures, MapInfo_Map_supportedGametypes, MapInfo_Map_title, MapInfo_Type_FromString(), strstrofs, strtolower(), substring(), and vector.

Referenced by _MapInfo_Generate(), and MapInfo_Get_ByName_NoFallbacks().

◆ MapInfo_BSPName_ByID()

string MapInfo_BSPName_ByID ( float i )

Definition at line 250 of file mapinfo.qc.

{
    return _MapInfo_GlobItem(MapInfo_FilterList_Lookup(i));
}

References _MapInfo_GlobItem(), and MapInfo_FilterList_Lookup().

Referenced by InstantAction_LoadMap(), MapInfo_Get_ByID(), MapList_Add_All(), MapList_LoadMap(), XonoticMapList_g_maplistCacheToggle(), and XonoticMapList_refilter().

◆ MapInfo_Cache_Create()

void MapInfo_Cache_Create ( )

Definition at line 53 of file mapinfo.qc.

{
    MapInfo_Cache_Destroy();
    _MapInfo_Cache_DB_NameToIndex = db_create();
    _MapInfo_Cache_Buf_IndexToMapData = buf_create();
    _MapInfo_Cache_Active = 1;
}

References _MapInfo_Cache_Active, _MapInfo_Cache_Buf_IndexToMapData, _MapInfo_Cache_DB_NameToIndex, buf_create, db_create(), and MapInfo_Cache_Destroy().

Referenced by MapInfo_Cache_Invalidate(), and preMenuInit().

◆ MapInfo_Cache_Destroy()

void MapInfo_Cache_Destroy ( )

Definition at line 43 of file mapinfo.qc.

{
    if(!_MapInfo_Cache_Active)
        return;
 
    db_close(_MapInfo_Cache_DB_NameToIndex);
    buf_del(_MapInfo_Cache_Buf_IndexToMapData);
    _MapInfo_Cache_Active = 0;
}

References _MapInfo_Cache_Active, _MapInfo_Cache_Buf_IndexToMapData, _MapInfo_Cache_DB_NameToIndex, and db_close().

Referenced by MapInfo_Cache_Create(), and MapInfo_Shutdown().

◆ MapInfo_Cache_Invalidate()

void MapInfo_Cache_Invalidate ( )

Definition at line 61 of file mapinfo.qc.

{
    if(!_MapInfo_Cache_Active)
        return;
 
    MapInfo_Cache_Create();
}

References _MapInfo_Cache_Active, and MapInfo_Cache_Create().

Referenced by MapInfo_Enumerate().

◆ MapInfo_CheckMap()

float MapInfo_CheckMap ( string s )

Definition at line 1510 of file mapinfo.qc.

{
    float r;
    r = _MapInfo_CheckMap(s, false);
    MapInfo_ClearTemps();
    return r;
}

References _MapInfo_CheckMap(), and MapInfo_ClearTemps().

Referenced by DoNextMapOverride(), GenericCommand_maplist(), getmaplist(), GotoMap(), Map_Check(), MapList_LoadMap(), MapVote_AddVotable(), MapVote_Suggest(), and ValidateMap().

◆ MapInfo_ClearTemps()

void MapInfo_ClearTemps ( )

Definition at line 1639 of file mapinfo.qc.

{
    MapInfo_Map_bspname = string_null;
    MapInfo_Map_title = string_null;
    MapInfo_Map_titlestring = string_null;
    MapInfo_Map_description = string_null;
    MapInfo_Map_author = string_null;
    MapInfo_Map_clientstuff = string_null;
    MapInfo_Map_supportedGametypes = '0 0 0';
    MapInfo_Map_supportedFeatures = 0;
}

References MapInfo_Map_author, MapInfo_Map_bspname, MapInfo_Map_clientstuff, MapInfo_Map_description, MapInfo_Map_supportedFeatures, MapInfo_Map_supportedGametypes, MapInfo_Map_title, MapInfo_Map_titlestring, and string_null.

Referenced by _MapInfo_FilterGametype(), getladder(), getlsmaps(), getmaplist(), getrankings(), getrecords(), InitGameplayMode(), MapInfo_CheckMap(), MapInfo_FilterString(), MapInfo_Shutdown(), SendWelcomeMessage(), XonoticMapInfoDialog_loadMapInfo(), and XonoticMapList_drawListBoxItem().

◆ MapInfo_CurrentFeatures()

int MapInfo_CurrentFeatures ( )

Definition at line 1480 of file mapinfo.qc.

{
    int req = 0;
    // TODO: find a better way to check if weapons are required on the map
    if(!(cvar("g_instagib") || cvar("g_overkill") || cvar("g_nix") || cvar("g_weaponarena") || !cvar("g_pickup_items") || !cvar("g_melee_only") 
        || cvar("g_race") || cvar("g_cts") || cvar("g_nexball") || cvar("g_ca") || cvar("g_freezetag") || cvar("g_lms")))
        req |= MAPINFO_FEATURE_WEAPONS;
    return req;
}

References cvar(), and MAPINFO_FEATURE_WEAPONS.

Referenced by _MapInfo_CheckMap(), GameTypeVote_SetGametype(), GenericCommand_maplist(), GotoFirstMap(), InstantAction_LoadMap(), make_mapinfo_Think(), MapInfo_ListAllAllowedMaps(), MapInfo_ListAllowedMaps(), MapVote_Start(), MapVote_Think(), RestoreGame(), spawnfunc(), spawnfunc(), and XonoticMapList_refilter().

◆ MapInfo_CurrentGametype()

Gametype MapInfo_CurrentGametype ( )

Definition at line 1490 of file mapinfo.qc.

{
    Gametype prev = MapInfo_Type_FromString(cvar_string("gamecfg"), false, false);
    FOREACH(Gametypes, cvar(it.netname) && it != prev, return it);
    return prev ? prev : MAPINFO_TYPE_DEATHMATCH;
}

References cvar(), cvar_string(), FOREACH, MapInfo_Type_FromString(), and prev.

Referenced by _MapInfo_CheckMap(), Campaign_Invalid(), GameType_ConfigureSliders_for_CurrentGametype(), GameTypeVote_Finished(), GameTypeVote_GetMask(), GameTypeVote_SetGametype(), GameTypeVote_Start(), GenericCommand_maplist(), GotoFirstMap(), InstantAction_LoadMap(), make_mapinfo_Think(), MapHasRightSize(), MapInfo_ListAllAllowedMaps(), MapInfo_LoadMapSettings(), Maplist_Init(), MapVote_Start(), MapVote_Think(), RestoreGame(), spawnfunc(), spawnfunc(), STATIC_INIT_LATE(), XonoticGametypeList_loadCvars(), XonoticGametypeList_saveCvars(), and XonoticMapList_refilter().

◆ MapInfo_Enumerate()

void MapInfo_Enumerate ( )

Definition at line 134 of file mapinfo.qc.

{
    if(_MapInfo_globopen)
    {
        search_end(_MapInfo_globhandle);
        _MapInfo_globopen = 0;
    }
    MapInfo_Cache_Invalidate();
    _MapInfo_globhandle = search_begin("maps/*.bsp", true, true);
    if(_MapInfo_globhandle >= 0)
    {
        _MapInfo_globcount = search_getsize(_MapInfo_globhandle);
        _MapInfo_globopen = 1;
    }
    else
        _MapInfo_globcount = 0;
}

References _MapInfo_globcount, _MapInfo_globhandle, _MapInfo_globopen, MapInfo_Cache_Invalidate(), search_begin(), search_end(), and search_getsize().

Referenced by GameCommand_make_mapinfo(), GameTypeVote_MapInfo_FixName(), GameTypeVote_SetGametype(), GenericCommand_maplist(), GotoFirstMap(), MapInfo_ListAllAllowedMaps(), MapInfo_ListAllowedMaps(), MapVote_Start(), preMenuInit(), RestoreGame(), spawnfunc(), and spawnfunc().

◆ MapInfo_FilterGametype()

float MapInfo_FilterGametype	(	Gametype	gametypeFlags,
		float	features,
		float	pFlagsRequired,
		float	pFlagsForbidden,
		float	pAbortOnGenerate )

◆ MapInfo_FilterString()

void MapInfo_FilterString ( string sf )

Definition at line 213 of file mapinfo.qc.

{
    // this function further filters _MapInfo_filtered, which is prepared by MapInfo_FilterGametype by string
    float i, j;
    string title;
 
    for(i = 0, j = -1; i < MapInfo_count; ++i)
    {
        if (MapInfo_Get_ByID(i))
        {
            // prepare for keyword filter
            if (MapInfo_Map_title && strstrofs(MapInfo_Map_title, "<TITLE>", 0) == -1)
                title = MapInfo_Map_title;
            else
                title = MapInfo_Map_bspname;
            // keyword filter
            if((strstrofs(strtolower(title), strtolower(sf), 0)) >= 0)
                bufstr_set(_MapInfo_filtered, ++j, bufstr_get(_MapInfo_filtered, i));
        }
    }
    MapInfo_count = j + 1;
    MapInfo_ClearTemps();
 
    // sometimes the glob isn't sorted nicely, so fix it here...
    heapsort(MapInfo_count, _MapInfo_FilterList_swap, _MapInfo_FilterList_cmp, NULL);
}

References _MapInfo_filtered, _MapInfo_FilterList_cmp(), _MapInfo_FilterList_swap(), heapsort(), MapInfo_ClearTemps(), MapInfo_count, MapInfo_Get_ByID(), MapInfo_Map_bspname, MapInfo_Map_title, NULL, strstrofs, and strtolower().

Referenced by XonoticMapList_refilter().

◆ MapInfo_FindName()

float MapInfo_FindName ( string s )

Definition at line 1426 of file mapinfo.qc.

{
    // if there is exactly one map of prefix s, return it
    // if not, return the null string
    // note that DP sorts glob results... so I can use a binary search
    float l, r, m, cmp;
    l = 0;
    r = MapInfo_count;
    // invariants: r is behind s, l-1 is equal or before
    while(l != r)
    {
        m = floor((l + r) / 2);
        MapInfo_FindName_match = _MapInfo_GlobItem(MapInfo_FilterList_Lookup(m));
        cmp = strcasecmp(MapInfo_FindName_match, s);
        if(cmp == 0)
            return m; // found and good
        if(cmp < 0)
            l = m + 1; // l-1 is before s
        else
            r = m; // behind s
    }
    MapInfo_FindName_match = _MapInfo_GlobItem(MapInfo_FilterList_Lookup(l));
    MapInfo_FindName_firstResult = l;
    // r == l, so: l is behind s, l-1 is before
    // SO: if there is any, l is the one with the right prefix
    //     and l+1 may be one too
    if(l == MapInfo_count)
    {
        MapInfo_FindName_match = string_null;
        MapInfo_FindName_firstResult = -1;
        return -1; // no MapInfo_FindName_match, behind last item
    }
    if(!startsWithNocase(MapInfo_FindName_match, s))
    {
        MapInfo_FindName_match = string_null;
        MapInfo_FindName_firstResult = -1;
        return -1; // wrong prefix
    }
    if(l == MapInfo_count - 1)
        return l; // last one, nothing can follow => unique
    if(startsWithNocase(_MapInfo_GlobItem(MapInfo_FilterList_Lookup(l + 1)), s))
    {
        MapInfo_FindName_match = string_null;
        return -1; // ambigous MapInfo_FindName_match
    }
    return l;
}

References _MapInfo_GlobItem(), floor(), MapInfo_count, MapInfo_FilterList_Lookup(), MapInfo_FindName_firstResult, MapInfo_FindName_match, startsWithNocase(), strcasecmp, and string_null.

Referenced by MapInfo_FixName(), XonoticMapList_keyDown(), and XonoticMapList_refilter().

◆ MapInfo_FixName()

string MapInfo_FixName ( string s )

Definition at line 1474 of file mapinfo.qc.

{
    MapInfo_FindName(s);
    return MapInfo_FindName_match;
}

References MapInfo_FindName(), and MapInfo_FindName_match.

Referenced by GameTypeVote_MapInfo_FixName(), and ValidateMap().

◆ MapInfo_ForbiddenFlags()

int MapInfo_ForbiddenFlags ( )

Definition at line 1664 of file mapinfo.qc.

{
    int f = MAPINFO_FLAG_FORBIDDEN;
 
#ifdef GAMEQC
    if (!cvar("g_maplist_allow_hidden"))
#endif
        f |= MAPINFO_FLAG_HIDDEN;
 
    if (!cvar("g_maplist_allow_frustrating"))
        f |= MAPINFO_FLAG_FRUSTRATING;
 
    return f;
}

References cvar(), MAPINFO_FLAG_FORBIDDEN, MAPINFO_FLAG_FRUSTRATING, and MAPINFO_FLAG_HIDDEN.

Referenced by GameTypeVote_MapInfo_FixName(), GameTypeVote_SetGametype(), GenericCommand_maplist(), getlsmaps(), GotoFirstMap(), InstantAction_LoadMap(), make_mapinfo_Think(), MapList_Add_All(), Maplist_Init(), MapVote_Start(), MapVote_Think(), RestoreGame(), spawnfunc(), spawnfunc(), and XonoticMapList_refilter().

◆ MapInfo_Get_ByID()

bool MapInfo_Get_ByID ( int i )

Definition at line 275 of file mapinfo.qc.

{
    return MapInfo_Get_ByName(MapInfo_BSPName_ByID(i), 0, NULL) ? true : false;
}

References MapInfo_BSPName_ByID(), MapInfo_Get_ByName(), NULL, and true.

Referenced by getladder(), getlsmaps(), MapInfo_FilterString(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), XonoticMapInfoDialog_loadMapInfo(), and XonoticMapList_drawListBoxItem().

◆ MapInfo_Get_ByName()

int MapInfo_Get_ByName	(	string	s,
		float	allowGenerate,
		Gametype	gametypeToSet )

Definition at line 1390 of file mapinfo.qc.

{
    int r = MapInfo_Get_ByName_NoFallbacks(pFilename, pAllowGenerate, pGametypeToSet);
 
    FOREACH(Gametypes, it.m_isForcedSupported(it), _MapInfo_Map_ApplyGametypeEx("", pGametypeToSet, it));
 
    if(pGametypeToSet)
    {
        if(!(MapInfo_Map_supportedGametypes & pGametypeToSet.gametype_flags))
        {
            error("Can't select the requested gametype. This should never happen as the caller should prevent it!\n");
            //_MapInfo_Map_ApplyGametypeEx("", pGametypeToSet, MAPINFO_TYPE_DEATHMATCH);
            //return;
        }
    }
 
    return r;
}

References _MapInfo_Map_ApplyGametypeEx(), error, FOREACH, MapInfo_Get_ByName_NoFallbacks(), and MapInfo_Map_supportedGametypes.

Referenced by _MapInfo_CheckMap(), _MapInfo_FilterGametype(), GameTypeVote_AvailabilityStatus(), get_mi_min_max(), MapInfo_Get_ByID(), MapInfo_LoadMapSettings(), and SendWelcomeMessage().

◆ MapInfo_ListAllAllowedMaps()

string MapInfo_ListAllAllowedMaps	(	float	pFlagsRequired,
		float	pFlagsForbidden )

Definition at line 1556 of file mapinfo.qc.

{
    string out;
 
    // to make absolutely sure:
    MapInfo_Enumerate();
    _MapInfo_FilterGametype(MAPINFO_TYPE_ALL, 0, pRequiredFlags, pForbiddenFlags, 0);
 
    out = "";
    for(float i = 0; i < MapInfo_count; ++i)
        out = strcat(out, " ", _MapInfo_GlobItem(MapInfo_FilterList_Lookup(i)));
 
    MapInfo_FilterGametype(MapInfo_CurrentGametype(), MapInfo_CurrentFeatures(), pRequiredFlags, pForbiddenFlags, 0);
 
    return substring(out, 1, strlen(out) - 1);
}

References _MapInfo_FilterGametype(), _MapInfo_GlobItem(), MapInfo_count, MapInfo_CurrentFeatures(), MapInfo_CurrentGametype(), MapInfo_Enumerate(), MapInfo_FilterGametype(), MapInfo_FilterList_Lookup(), MAPINFO_TYPE_ALL, strcat(), strlen, and substring().

◆ MapInfo_ListAllowedMaps()

string MapInfo_ListAllowedMaps	(	Gametype	type,
		float	pFlagsRequired,
		float	pFlagsForbidden )

Definition at line 1542 of file mapinfo.qc.

{
    string out;
 
    // to make absolutely sure:
    MapInfo_Enumerate();
    MapInfo_FilterGametype(type, MapInfo_CurrentFeatures(), pRequiredFlags, pForbiddenFlags, 0);
 
    out = "";
    for(float i = 0; i < MapInfo_count; ++i)
        out = strcat(out, " ", _MapInfo_GlobItem(MapInfo_FilterList_Lookup(i)));
    return substring(out, 1, strlen(out) - 1);
}

References _MapInfo_GlobItem(), MapInfo_count, MapInfo_CurrentFeatures(), MapInfo_Enumerate(), MapInfo_FilterGametype(), MapInfo_FilterList_Lookup(), strcat(), strlen, and substring().

Referenced by GameTypeVote_SetGametype(), and Maplist_Init().

◆ MapInfo_LoadMap()

void MapInfo_LoadMap	(	string	s,
		float	reinit )

Definition at line 1523 of file mapinfo.qc.

{
    MapInfo_Map_supportedGametypes = '0 0 0';
    // we shouldn't need this, as LoadMapSettings already fixes the gametype
    //if(!MapInfo_CheckMap(s))
    //{
    //  print("EMERGENCY: can't play the selected map in the given gametype. Falling back to DM.\n");
    //  MapInfo_SwitchGameType(MAPINFO_TYPE_DEATHMATCH.gametype_flags);
    //}
 
    LOG_INFO("Switching to map ", s);
 
    cvar_settemp_restore();
    if(reinit)
        localcmd(strcat("\nmap ", s, "\n"));
    else
        localcmd(strcat("\nchangelevel ", s, "\n"));
}

References cvar_settemp_restore(), localcmd(), LOG_INFO, MapInfo_Map_supportedGametypes, and strcat().

Referenced by CampaignSetup(), InstantAction_LoadMap(), Map_Goto(), and MapList_LoadMap().

◆ MapInfo_LoadMapSettings()

void MapInfo_LoadMapSettings ( string s )

Definition at line 1580 of file mapinfo.qc.

{
    Gametype t = MapInfo_CurrentGametype();
    MapInfo_LoadMapSettings_SaveGameType(t);
 
    if(!_MapInfo_CheckMap(s, true)) // with underscore, it keeps temps
    {
        if(cvar("g_mapinfo_allow_unsupported_modes_and_let_stuff_break"))
        {
            LOG_SEVERE("can't play the selected map in the given gametype. Working with only the override settings.");
            _MapInfo_Map_ApplyGametypeEx("", t, t);
            return; // do not call Get_ByName!
        }
 
        if(MapInfo_Map_supportedGametypes == '0 0 0')
        {
            RandomSelection_Init();
            FOREACH(Gametypes, it.m_priority == 2, 
            {
                MapInfo_Map_supportedGametypes |= it.gametype_flags;
                RandomSelection_AddEnt(it, 1, 1);
            });
            if(RandomSelection_chosen_ent)
                t = RandomSelection_chosen_ent;
            LOG_SEVEREF("Mapinfo system is not functional at all. Falling back to a preferred mode (%s).", t.mdl);
            MapInfo_LoadMapSettings_SaveGameType(t);
            _MapInfo_Map_ApplyGametypeEx("", t, t);
            return; // do not call Get_ByName!
        }
 
#if 0
        // find the lowest bit in the supported gametypes
        // unnecessary now that we select one at random
        int _t = 1;
        while(!(MapInfo_Map_supportedGametypes & 1))
        {
            _t <<= 1;
            MapInfo_Map_supportedGametypes = floor(MapInfo_Map_supportedGametypes >> 1);
        }
#endif
        RandomSelection_Init();
        Gametype t_prev = t;
        FOREACH(Gametypes, MapInfo_Map_supportedGametypes & it.gametype_flags,
        {
            RandomSelection_AddEnt(it, 1, it.m_priority);
        });
        if(RandomSelection_chosen_ent)
            t = RandomSelection_chosen_ent;
 
        // t is now a supported mode!
        LOG_WARNF("can't play the selected map in the given gametype (%s). Falling back to a supported mode (%s).", t_prev.mdl, t.mdl);
        MapInfo_LoadMapSettings_SaveGameType(t);
    }
    if(!_MapInfo_CheckMap(s, false)) { // with underscore, it keeps temps
        LOG_WARNF("the selected map lacks features required by current settings; playing anyway.");
    }
    MapInfo_Get_ByName(s, 1, t);
}

References _MapInfo_CheckMap(), _MapInfo_Map_ApplyGametypeEx(), cvar(), floor(), FOREACH, LOG_SEVERE, LOG_SEVEREF, LOG_WARNF, MapInfo_CurrentGametype(), MapInfo_Get_ByName(), MapInfo_LoadMapSettings_SaveGameType(), MapInfo_Map_supportedGametypes, RandomSelection_chosen_ent, and RandomSelection_Init().

Referenced by InitGameplayMode().

◆ MapInfo_RequiredFlags()

int MapInfo_RequiredFlags ( )

Definition at line 1679 of file mapinfo.qc.

{
    int f = 0;
 
    if(cvar("g_maplist_allow_frustrating") > 1)
        f |= MAPINFO_FLAG_FRUSTRATING;
 
    return f;
}

References cvar(), and MAPINFO_FLAG_FRUSTRATING.

Referenced by GameTypeVote_MapInfo_FixName(), GameTypeVote_SetGametype(), GenericCommand_maplist(), GotoFirstMap(), InstantAction_LoadMap(), make_mapinfo_Think(), Maplist_Init(), MapVote_Start(), MapVote_Think(), RestoreGame(), spawnfunc(), spawnfunc(), and XonoticMapList_refilter().

◆ MapInfo_Shutdown()

void MapInfo_Shutdown ( )

Definition at line 1651 of file mapinfo.qc.

{
    MapInfo_ClearTemps();
    MapInfo_Filter_Free();
    MapInfo_Cache_Destroy();
    if(_MapInfo_globopen)
    {
        search_end(_MapInfo_globhandle);
        _MapInfo_globhandle = -1;
        _MapInfo_globopen = false;
    }
}

References _MapInfo_globhandle, _MapInfo_globopen, MapInfo_Cache_Destroy(), MapInfo_ClearTemps(), MapInfo_Filter_Free(), and search_end().

Referenced by __init_dedicated_server_shutdown(), RestoreGame(), Shutdown(), and XonoticMapList_destroy().

◆ MapInfo_SwitchGameType()

void MapInfo_SwitchGameType ( Gametype t )

Definition at line 1518 of file mapinfo.qc.

{
    FOREACH(Gametypes, true, cvar_set(it.netname, (it == t) ? "1" : "0"));
}

References cvar_set(), and FOREACH.

Referenced by CampaignPreInit(), GameTypeVote_SetGametype(), InstantAction_LoadMap(), MapInfo_LoadMapSettings_SaveGameType(), target_changelevel_use(), and XonoticGametypeList_saveCvars().

◆ MapInfo_Type_Description()

string MapInfo_Type_Description ( Gametype t )

Definition at line 651 of file mapinfo.qc.

{
    return t ? t.m_description : "";
}

Referenced by GameTypeVote_ReadOption(), and XonoticGametypeList_focusedItemChangeNotify().

◆ MapInfo_Type_FromString()

Gametype MapInfo_Type_FromString	(	string	t,
		bool	dowarn,
		bool	is_q3compat )

Definition at line 621 of file mapinfo.qc.

{
    string replacement = "";
 
    switch (gtype)
    {
        case "nexball":   replacement = "nb"; break;
        case "freezetag": replacement = "ft"; break;
        case "keepaway":  replacement = "ka"; break;
        case "invasion":  replacement = "inv"; break;
        case "assault":   replacement = "as"; break;
        case "race":      replacement = "rc"; break;
        // Q3/QL compat, see DoesQ3ARemoveThisEntity() in quake3.qc for complete lists
        case "ffa":       replacement = "dm"; break;
        case "cctf": // from ThreeWave, maps with this should all have "ctf" too
        case "oneflag":   replacement = "ctf"; break;
        case "tourney":   replacement = "duel"; break;
        case "arena": // which Q3 mod is this from? In Nexuiz it was 'duel with rounds'.
            if(is_q3compat) { replacement = "ca"; } break;
    }
    if (replacement != "")
    {
        if (dowarn && WARN_COND)
            LOG_WARNF("MapInfo_Type_FromString (probably %s): using deprecated name '%s'. Should use '%s'.", MapInfo_Map_bspname, gtype, replacement);
        gtype = replacement;
    }
    FOREACH(Gametypes, it.mdl == gtype, return it);
    return NULL;
}

References FOREACH, LOG_WARNF, MapInfo_Map_bspname, NULL, and WARN_COND.

Referenced by _MapInfo_ParseArena(), Campaign_Invalid(), CampaignPreInit(), GameCommand_gametype(), GameTypeVote_AvailabilityStatus(), GameTypeVote_ReadOption(), GameTypeVote_Type_FromString(), MapInfo_CurrentGametype(), MapInfo_Get_ByName_NoFallbacks(), target_changelevel_use(), and XonoticServerInfoDialog_loadServerInfo().

◆ MapInfo_Type_ToString()

string MapInfo_Type_ToString ( Gametype t )

Definition at line 656 of file mapinfo.qc.

{
    return t ? t.mdl : "";
}

Referenced by _MapInfo_Map_ApplyGametypeEx(), GameType_GetIcon(), Gametype_Init(), GameTypeVote_SetGametype(), GameTypeVote_Start(), GetGametype(), isGametypeInFilter(), MapVote_SendEntity(), and ServerList_TypeSort_Click().

◆ MapInfo_Type_ToText()

string MapInfo_Type_ToText ( Gametype t )

Definition at line 661 of file mapinfo.qc.

{
    /* xgettext:no-c-format */
    return t ? t.message : _("@!#%'n Tuba Throwing");
}

Referenced by Announcer_Gamestart(), GameType_GetName(), GameTypeVote_ReadOption(), MapVote_SendEntity(), net_handle_ServerWelcome(), Scoreboard_Draw(), XonoticGameMessageSettingsTab_fill(), XonoticHUDModIconsDialog_fill(), XonoticMapInfoDialog_fill(), and XonoticServerInfoDialog_loadServerInfo().

◆ MapReadSizes()

bool MapReadSizes ( string map )

Definition at line 1409 of file mapinfo.qc.

{
    // TODO: implement xonotic#28 / xonvote 172 (sizes in mapinfo)
    string readsize_msg = strcat("MapReadSizes ", map);
    float fh = fopen(strcat("maps/", map, ".sizes"), FILE_READ);
    if(fh >= 0)
    {
        map_minplayers = stoi(fgets(fh));
        map_maxplayers = stoi(fgets(fh));
        fclose(fh);
        LOG_TRACEF(readsize_msg, ": ok, min %d max %d", map_minplayers, map_maxplayers);
        return true;
    }
    LOG_TRACE(readsize_msg, ": not found");
    return false;
}

References fclose(), fgets(), FILE_READ, fopen(), LOG_TRACE, LOG_TRACEF, map_maxplayers, map_minplayers, stoi, and strcat().

Referenced by GameplayMode_DelayedInit(), and MapHasRightSize().

◆ STATIC_INIT()

STATIC_INIT ( Gametypes_renumber )

Definition at line 140 of file mapinfo.qh.

{
    FOREACH(Gametypes, true,
    {
        it.m_id = i;
        vector set = it.gametype_flags = _GametypeFlags_FromGametype(it.m_id);
        MAPINFO_TYPE_ALL |= set;
    });
}