SpawnUi

Use this class to control the loadout and deployment UI.

Static members

Member

Description

hasBeenClosed

True if the UI has been closed at least once this game.

hasBeenOpen

True if the UI has been open at least once this game.

isOpen

playerCanSelectSpawnPoint

True if the player can select their spawn point from the loadout minimap.

Static methods

Method

Description

Close()

Closes the UI.

GetSelectedSpawnPoint()

Returns the player selected spawn point.

Open()

Opens the UI.

OpenBattlePlan()

Opens the UI in battle plan mode.

SetLoadoutOverride(loadout)

Override the loadout section of the UI.

SetLoadoutVisible(visible)

Show or hide the loadout section.

SetMinimapOverride(minimap)

Override the minimap section of the UI.

SetMinimapVisible(visible)

Show or hide the minimap/deploy section.

SetSelectedSpawnPoint(spawnPoint)

Sets the player selected spawn point.

Details

class SpawnUi
static const bool hasBeenClosed

True if the UI has been closed at least once this game.

static const bool hasBeenOpen

True if the UI has been open at least once this game.

static const bool isOpen
static bool playerCanSelectSpawnPoint

True if the player can select their spawn point from the loadout minimap.

static void Close()

Closes the UI.

static SpawnPoint GetSelectedSpawnPoint()

Returns the player selected spawn point.

static void Open()

Opens the UI.

static void OpenBattlePlan()

Opens the UI in battle plan mode.

static void SetLoadoutOverride(GameObject loadout)

Override the loadout section of the UI.

static void SetLoadoutVisible(bool visible)

Show or hide the loadout section.

static void SetMinimapOverride(GameObject minimap)

Override the minimap section of the UI.

static void SetMinimapVisible(bool visible)

Show or hide the minimap/deploy section.

static void SetSelectedSpawnPoint(SpawnPoint spawnPoint)

Sets the player selected spawn point. If set to null, the player will not automatically spawn.