Interface IGameMapManager

Manages which station map will be used for the next round.

Namespace: Content.Server.Maps
Assembly: Content.Server.dll
Syntax
public interface IGameMapManager

Methods

| Improve this Doc View Source

AllMaps()

Returns all maps.

Declaration
IEnumerable<GameMapPrototype> AllMaps()
Returns
Type Description
IEnumerable<GameMapPrototype>

enumerator of map prototypes
| Improve this Doc View Source

AllVotableMaps()

Returns all maps that can be voted for.

Declaration
IEnumerable<GameMapPrototype> AllVotableMaps()
Returns
Type Description
IEnumerable<GameMapPrototype>

enumerator of map prototypes
| Improve this Doc View Source

CheckMapExists(String)

Checks if the given map exists

Declaration
bool CheckMapExists(string gameMap)
Parameters
Type Name Description
System.String gameMap

name of the map
Returns
Type Description
System.Boolean

existence
| Improve this Doc View Source

ClearSelectedMap()

Clears the selected map, if any

Declaration
void ClearSelectedMap()
| Improve this Doc View Source

CurrentlyEligibleMaps()

Returns all maps eligible to be played right now.

Declaration
IEnumerable<GameMapPrototype> CurrentlyEligibleMaps()
Returns
Type Description
IEnumerable<GameMapPrototype>

enumerator of map prototypes
| Improve this Doc View Source

GetSelectedMap()

Gets the currently selected map

Declaration
GameMapPrototype GetSelectedMap()
Returns
Type Description
GameMapPrototype

selected map
| Improve this Doc View Source

Initialize()

Declaration
void Initialize()
| Improve this Doc View Source

SelectMap(String)

Select the given map regardless of eligibility

Declaration
void SelectMap(string gameMap)
Parameters
Type Name Description
System.String gameMap

map prototype
| Improve this Doc View Source

SelectMapByConfigRules()

Selects the map by following rules set in the config

Declaration
void SelectMapByConfigRules()
| Improve this Doc View Source

SelectMapFromRotationQueue(Boolean)

Selects the map at the front of the rotation queue

Declaration
void SelectMapFromRotationQueue(bool markAsPlayed = false)
Parameters
Type Name Description
System.Boolean markAsPlayed
| Improve this Doc View Source

SelectMapRandom()

Selects a random map eligible map

Declaration
void SelectMapRandom()
| Improve this Doc View Source

TrySelectMapIfEligible(String)

Attempts to select the given map, checking eligibility criteria

Declaration
bool TrySelectMapIfEligible(string gameMap)
Parameters
Type Name Description
System.String gameMap

map prototype
Returns
Type Description
System.Boolean

success or failure