Class GameTicker

Inheritance

System.Object

SharedGameTicker

GameTicker

Namespace: Content.Server.GameTicking

Assembly: Content.Server.dll

Syntax

public sealed class GameTicker : SharedGameTicker

Fields

PlayersJoinedRoundNormally

How many players have joined the round through normal methods. Useful for game rules to look at. Doesn't count observers, people in lobby, etc.

Declaration

public int PlayersJoinedRoundNormally

Field Value

Type	Description
System.Int32

PresetFailedCooldownIncrease

Declaration

public const float PresetFailedCooldownIncrease = null

Field Value

Type	Description
System.Single

Properties

AllPreviousGameRules

A list storing the start times of all game rules that have been started this round. Game rules can be started and stopped at any time, including midround.

Declaration

public IReadOnlyList<(TimeSpan, string)> AllPreviousGameRules { get; }

Property Value

Type	Description
IReadOnlyList<System.ValueTuple<TimeSpan, System.String>>

CurrentPreset

The preset that's currently active.

Declaration

public GamePresetPrototype CurrentPreset { get; }

Property Value

Type	Description
GamePresetPrototype

DefaultMap

Declaration

public MapId DefaultMap { get; }

Property Value

Type	Description
Robust.Shared.Map.MapId

DisallowLateJoin

Declaration

public bool DisallowLateJoin { get; }

Property Value

Type	Description
System.Boolean

DummyTicker

Declaration

public bool DummyTicker { get; }

Property Value

Type	Description
System.Boolean

LobbyBackground

Declaration

public string? LobbyBackground { get; }

Property Value

Type	Description
System.Nullable<System.String>

LobbyDuration

Declaration

public TimeSpan LobbyDuration { get; }

Property Value

Type	Description
TimeSpan

LobbyEnabled

Declaration

public bool LobbyEnabled { get; }

Property Value

Type	Description
System.Boolean

LobbySong

Declaration

public string? LobbySong { get; }

Property Value

Type	Description
System.Nullable<System.String>

MaxStationOffset

Declaration

public float MaxStationOffset { get; }

Property Value

Type	Description
System.Single

Paused

Declaration

public bool Paused { get; set; }

Property Value

Type	Description
System.Boolean

PlayerGameStatuses

The game status of a players user Id. May contain disconnected players

Declaration

public IReadOnlyDictionary<NetUserId, PlayerGameStatus> PlayerGameStatuses { get; }

Property Value

Type	Description
IReadOnlyDictionary<Robust.Shared.Network.NetUserId, PlayerGameStatus>

Preset

The selected preset that will be used at the start of the next round.

Declaration

public GamePresetPrototype Preset { get; }

Property Value

Type	Description
GamePresetPrototype

RoundPreloadTime

How long before RoundStartTime do we load maps.

Declaration

public TimeSpan RoundPreloadTime { get; }

Property Value

Type	Description
TimeSpan

RoundStartFailShutdownCount

Declaration

public int RoundStartFailShutdownCount { get; }

Property Value

Type	Description
System.Int32

RunLevel

Declaration

public GameRunLevel RunLevel { get; }

Property Value

Type	Description
GameRunLevel

ServerName

Declaration

public string? ServerName { get; }

Property Value

Type	Description
System.Nullable<System.String>

StationOffset

Declaration

public bool StationOffset { get; }

Property Value

Type	Description
System.Boolean

StationRotation

Declaration

public bool StationRotation { get; }

Property Value

Type	Description
System.Boolean

Methods

AddGameRule(String)

Adds a game rule to the list, but does not start it yet, instead waiting until the rule is actually started by other code (usually roundstart)

Declaration

public EntityUid AddGameRule(string ruleId)

Parameters

Type	Name	Description
System.String	ruleId

Returns

Type	Description
EntityUid	The entity for the added gamerule

CanUpdateMap()

Returns true if the round's map is eligible to be updated.

Declaration

public bool CanUpdateMap()

Returns

Type	Description
System.Boolean

ChooseRandomLobbySong()

Plays a random song from the LobbyMusic sound collection.

Declaration

public void ChooseRandomLobbySong()

ClearGameRules()

Declaration

public void ClearGameRules()

DelayStart(TimeSpan)

Declaration

public bool DelayStart(TimeSpan time)

Parameters

Type	Name	Description
TimeSpan	time

Returns

Type	Description
System.Boolean

EndGameRule(EntityUid, GameRuleComponent)

Ends a game rule.

Declaration

public bool EndGameRule(EntityUid ruleEntity, GameRuleComponent ruleData = null)

Parameters

Type	Name	Description
EntityUid	ruleEntity
GameRuleComponent	ruleData

Returns

Type	Description
System.Boolean

EndRound(String)

Declaration

public void EndRound(string text = "")

Parameters

Type	Name	Description
System.String	text

FindGamePreset(String)

Declaration

public GamePresetPrototype FindGamePreset(string preset)

Parameters

Type	Name	Description
System.String	preset

Returns

Type	Description
GamePresetPrototype

GetActiveGameRules()

Gets all the gamerule entities which are currently active.

Declaration

public IEnumerable<EntityUid> GetActiveGameRules()

Returns

Type	Description
IEnumerable<EntityUid>

GetAddedGameRules()

Gets all the gamerule entities which are currently active.

Declaration

public IEnumerable<EntityUid> GetAddedGameRules()

Returns

Type	Description
IEnumerable<EntityUid>

GetAllGameRulePrototypes()

Gets all gamerule prototypes

Declaration

public IEnumerable<EntityPrototype> GetAllGameRulePrototypes()

Returns

Type	Description
IEnumerable<Robust.Shared.Prototypes.EntityPrototype>

GetObserverSpawnPoint()

Declaration

public EntityCoordinates GetObserverSpawnPoint()

Returns

Type	Description
Robust.Shared.Map.EntityCoordinates

Initialize()

Declaration

public override void Initialize()

Overrides

SharedGameTicker.Initialize()

IsGameRuleActive(EntityUid, GameRuleComponent)

Declaration

public bool IsGameRuleActive(EntityUid ruleEntity, GameRuleComponent component = null)

Parameters

Type	Name	Description
EntityUid	ruleEntity
GameRuleComponent	component

Returns

Type	Description
System.Boolean

IsGameRuleActive(String)

Declaration

public bool IsGameRuleActive(string rule)

Parameters

Type	Name	Description
System.String	rule

Returns

Type	Description
System.Boolean

IsGameRuleAdded(EntityUid, GameRuleComponent)

Declaration

public bool IsGameRuleAdded(EntityUid ruleEntity, GameRuleComponent component = null)

Parameters

Type	Name	Description
EntityUid	ruleEntity
GameRuleComponent	component

Returns

Type	Description
System.Boolean

IsGameRuleAdded(String)

Declaration

public bool IsGameRuleAdded(string rule)

Parameters

Type	Name	Description
System.String	rule

Returns

Type	Description
System.Boolean

IsMapEligible(GameMapPrototype)

Declaration

public bool IsMapEligible(GameMapPrototype map)

Parameters

Type	Name	Description
GameMapPrototype	map

Returns

Type	Description
System.Boolean

JoinAsObserver(IPlayerSession)

Causes the given player to join the current game as observer ghost. See also SpawnObserver(IPlayerSession)

Declaration

public void JoinAsObserver(IPlayerSession player)

Parameters

Type	Name	Description
Robust.Server.Player.IPlayerSession	player

LoadGameMap(GameMapPrototype, MapId, MapLoadOptions, Nullable<String>)

Loads a new map, allowing systems interested in it to handle loading events. In the base game, this is required to be used if you want to load a station.

Declaration

public IReadOnlyList<EntityUid> LoadGameMap(GameMapPrototype map, MapId targetMapId, MapLoadOptions loadOptions, string? stationName = null)

Parameters

Type	Name	Description
GameMapPrototype	map	Game map prototype to load in.
Robust.Shared.Map.MapId	targetMapId	Map to load into.
Robust.Server.Maps.MapLoadOptions	loadOptions	Map loading options, includes offset.
System.Nullable<System.String>	stationName	Name to assign to the loaded station.

Returns

Type	Description
IReadOnlyList<EntityUid>	All loaded entities and grids.

MakeJoinGame(IPlayerSession, EntityUid, Nullable<String>, Boolean)

Makes a player join into the game and spawn on a staiton.

Declaration

public void MakeJoinGame(IPlayerSession player, EntityUid station, string? jobId = null, bool silent = false)

Parameters

Type	Name	Description
Robust.Server.Player.IPlayerSession	player	The player joining
EntityUid	station	The station they're spawning on
System.Nullable<System.String>	jobId	An optional job for them to spawn as
System.Boolean	silent	Whether or not the player should be greeted upon joining

OnGhostAttempt(EntityUid, Boolean, Boolean, MindComponent)

Declaration

public bool OnGhostAttempt(EntityUid mindId, bool canReturnGlobal, bool viaCommand = false, MindComponent mind = null)

Parameters

Type	Name	Description
EntityUid	mindId
System.Boolean	canReturnGlobal
System.Boolean	viaCommand
MindComponent	mind

Returns

Type	Description
System.Boolean

PauseStart(Boolean)

Declaration

public bool PauseStart(bool pause = true)

Parameters

Type	Name	Description
System.Boolean	pause

Returns

Type	Description
System.Boolean

PlayerJoinGame(IPlayerSession, Boolean)

Declaration

public void PlayerJoinGame(IPlayerSession session, bool silent = false)

Parameters

Type	Name	Description
Robust.Server.Player.IPlayerSession	session
System.Boolean	silent

PostInitialize()

Declaration

public void PostInitialize()

Respawn(IPlayerSession)

Declaration

public void Respawn(IPlayerSession player)

Parameters

Type	Name	Description
Robust.Server.Player.IPlayerSession	player

RestartRound()

Declaration

public void RestartRound()

RoundDuration()

Declaration

public TimeSpan RoundDuration()

Returns

Type	Description
TimeSpan

SetGamePreset(GamePresetPrototype, Boolean)

Declaration

public void SetGamePreset(GamePresetPrototype preset, bool force = false)

Parameters

Type	Name	Description
GamePresetPrototype	preset
System.Boolean	force

SetGamePreset(String, Boolean)

Declaration

public void SetGamePreset(string preset, bool force = false)

Parameters

Type	Name	Description
System.String	preset
System.Boolean	force

SetLobbySong(Nullable<String>)

Sets the current lobby song, or stops it if null.

Declaration

public void SetLobbySong(string? song)

Parameters

Type	Name	Description
System.Nullable<System.String>	song	The lobby song to play, or null to stop any lobby songs.

ShowRoundEndScoreboard(String)

Declaration

public void ShowRoundEndScoreboard(string text = "")

Parameters

Type	Name	Description
System.String	text

Shutdown()

Declaration

public override void Shutdown()

Overrides

SharedGameTicker.Shutdown()

SpawnObserver(IPlayerSession)

Spawns an observer ghost and attaches the given player to it. If the player does not yet have a mind, the player is given a new mind with the observer role. Otherwise, the current mind is transferred to the ghost.

Declaration

public void SpawnObserver(IPlayerSession player)

Parameters

Type	Name	Description
Robust.Server.Player.IPlayerSession	player

StartGameRule(EntityUid, GameRuleComponent)

Game rules can be 'started' separately from being added. 'Starting' them usually happens at round start while they can be added and removed before then.

Declaration

public bool StartGameRule(EntityUid ruleEntity, GameRuleComponent ruleData = null)

Parameters

Type	Name	Description
EntityUid	ruleEntity
GameRuleComponent	ruleData

Returns

Type	Description
System.Boolean

StartGameRule(String)

Game rules can be 'started' separately from being added. 'Starting' them usually happens at round start while they can be added and removed before then.

Declaration

public bool StartGameRule(string ruleId)

Parameters

Type	Name	Description
System.String	ruleId

Returns

Type	Description
System.Boolean

StartGameRule(String, out EntityUid)

Game rules can be 'started' separately from being added. 'Starting' them usually happens at round start while they can be added and removed before then.

Declaration

public bool StartGameRule(string ruleId, out EntityUid ruleEntity)

Parameters

Type	Name	Description
System.String	ruleId
EntityUid	ruleEntity

Returns

Type	Description
System.Boolean

StartRound(Boolean)

Declaration

public void StartRound(bool force = false)

Parameters

Type	Name	Description
System.Boolean	force

StopLobbySong()

Stops the current lobby song being played.

Declaration

public void StopLobbySong()

TogglePause()

Declaration

public bool TogglePause()

Returns

Type	Description
System.Boolean

ToggleReady(IPlayerSession, Boolean)

Declaration

public void ToggleReady(IPlayerSession player, bool ready)

Parameters

Type	Name	Description
Robust.Server.Player.IPlayerSession	player
System.Boolean	ready

ToggleReadyAll(Boolean)

Declaration

public void ToggleReadyAll(bool ready)

Parameters

Type	Name	Description
System.Boolean	ready

TryFindGamePreset(String, out GamePresetPrototype)

Declaration

public bool TryFindGamePreset(string preset, out GamePresetPrototype prototype)

Parameters

Type	Name	Description
System.String	preset
GamePresetPrototype	prototype

Returns

Type	Description
System.Boolean

Update(Single)

Declaration

public override void Update(float frameTime)

Parameters

Type	Name	Description
System.Single	frameTime

UpdateInfoText()

Declaration

public void UpdateInfoText()