ISource2ModMaps

What a map vote, a map chooser or an admin "map" command builds on; none of those are in the core.

A map is named the way the console takes it:

• "de_dust2" -- a map the server has (IsMapValid()), changed to with changelevel;
• "workshop/3070212801" or "3070212801" -- a Workshop map by its ID, changed to with host_workshop_map;
• any other name -- assumed to be a map of the server's Workshop collection, changed to with ds_workshop_changelevel.

Map lists come from configs/maplists.json, SourceMod's maplists.cfg as JSON:

{
  "mapcyclefile": { "file": "mapcycle.txt" },     // relative to the game directory
  "default":      { "target": "mapcyclefile" },   // another list's name
  "mapchooser":   { "maps": [ "de_dust2", "workshop/3070212801" ] }
}

A list that is not in the file falls back to "default", "default" to "mapcyclefile", and that to mapcycle.txt in the game directory. In a list file every line is a map; empty lines and lines starting with //, # or ; are skipped.

Interface id ISource2ModMaps001 (SOURCE2MOD_MAPS_INTERFACE) · Global g_pSource2ModMaps · Header source2mod/ISource2ModMaps.h

Methods

GetCurrentMap

virtual const char* GetCurrentMap() = 0;

The map running now ("de_dust2"); "" before the first one.

IsMapValid

virtual bool IsMapValid(const char* map) = 0;

Whether the server has this map (the engine's IsMapValid). Workshop maps that are not downloaded yet are not valid.

FindMap

virtual Source2ModFindMapResult FindMap(const char* map, std::string& found) = 0;

SourceMod's FindMap: the map a typed name means.

SetNextMap

virtual bool SetNextMap(const char* map) = 0;

The map the match moves to when it ends.

Sets the game's nextlevel as well; for a Workshop map the core changes level itself when the match ends (cs_win_panel_match, after mp_match_restart_delay).

Returns bool — false for a name FindMap() does not find at all.

GetNextMap

virtual const char* GetNextMap() = 0;

The next map: what SetNextMap() set, else the game's nextlevel, else the one after the current map in "mapcyclefile".

Returns const char* — "" when none of those gives one.

ChangeLevel

virtual bool ChangeLevel(const char* map, const char* reason) = 0;

Changes the map now (SourceMod's ForceChangeLevel).

Returns bool — false for an empty name.

GetMapHistorySize

virtual int GetMapHistorySize() = 0;

How many earlier maps the history holds (up to 32).

GetMapHistory

virtual bool GetMapHistory(int index, Source2ModMapHistoryEntry& entry) = 0;

An earlier map, 0 = the one before this one. false when out of range.

ReadMapList

virtual bool ReadMapList(const char* name, std::vector<std::string>& maps, int flags) = 0;

Reads a map list (see the file comment).

Returns bool — false when no list could be read (maps is left as it was).

Source2ModMapHistoryEntry

One map that was played, newest first in GetMapHistory().

Fields

Enums

Source2ModFindMapResult

enum Source2ModFindMapResult

SourceMod's FindMapResult, the same numbers.

Source2ModMapListFlags

enum Source2ModMapListFlags

ReadMapList() flags, SourceMod's MAPLIST_FLAG_* values.