Show / Hide Table of Contents

Class GameRuleSystem<T>

Inheritance
System.Object
GameRuleSystem<T>
AntagSelectionSystem
DeathMatchRuleSystem
GenericAntagRuleSystem
InactivityTimeRestartRuleSystem
KillCalloutRuleSystem
MaxTimeRestartRuleSystem
NukeopsRuleSystem
PiratesRuleSystem
RespawnRuleSystem
RevolutionaryRuleSystem
SandboxRuleSystem
SecretRuleSystem
TraitorRuleSystem
ZombieRuleSystem
BasicStationEventSchedulerSystem
StationEventSystem<T>
RampingStationEventSchedulerSystem
Namespace: Content.Server.GameTicking.Rules
Assembly: Content.Server.dll
Syntax
public abstract class GameRuleSystem<T> : EntitySystem where T : Component
Type Parameters
Name Description
T

Fields

| Improve this Doc View Source

ChatManager

Declaration
protected readonly IChatManager ChatManager
Field Value
Type Description
IChatManager
| Improve this Doc View Source

GameTicker

Declaration
protected readonly GameTicker GameTicker
Field Value
Type Description
GameTicker

Methods

| Improve this Doc View Source

ActiveTick(EntityUid, T, GameRuleComponent, Single)

Called on an active gamerule entity in the Update function

Declaration
protected virtual void ActiveTick(EntityUid uid, T component, GameRuleComponent gameRule, float frameTime)
Parameters
Type Name Description
EntityUid uid
T component
GameRuleComponent gameRule
System.Single frameTime
| Improve this Doc View Source

Added(EntityUid, T, GameRuleComponent, GameRuleAddedEvent)

Called when the gamerule is added

Declaration
protected virtual void Added(EntityUid uid, T component, GameRuleComponent gameRule, GameRuleAddedEvent args)
Parameters
Type Name Description
EntityUid uid
T component
GameRuleComponent gameRule
Content.Server.GameTicking.Rules.Components.GameRuleAddedEvent args
| Improve this Doc View Source

Ended(EntityUid, T, GameRuleComponent, GameRuleEndedEvent)

Called when the gamerule ends

Declaration
protected virtual void Ended(EntityUid uid, T component, GameRuleComponent gameRule, GameRuleEndedEvent args)
Parameters
Type Name Description
EntityUid uid
T component
GameRuleComponent gameRule
Content.Server.GameTicking.Rules.Components.GameRuleEndedEvent args
| Improve this Doc View Source

Initialize()

Declaration
public override void Initialize()
| Improve this Doc View Source

QueryActiveRules()

Declaration
protected EntityQueryEnumerator<ActiveGameRuleComponent, T, GameRuleComponent> QueryActiveRules()
Returns
Type Description
EntityQueryEnumerator<ActiveGameRuleComponent, T, GameRuleComponent>
| Improve this Doc View Source

Started(EntityUid, T, GameRuleComponent, GameRuleStartedEvent)

Called when the gamerule begins

Declaration
protected virtual void Started(EntityUid uid, T component, GameRuleComponent gameRule, GameRuleStartedEvent args)
Parameters
Type Name Description
EntityUid uid
T component
GameRuleComponent gameRule
Content.Server.GameTicking.Rules.Components.GameRuleStartedEvent args
| Improve this Doc View Source

TryRoundStartAttempt(RoundStartAttemptEvent, String)

Declaration
protected bool TryRoundStartAttempt(RoundStartAttemptEvent ev, string localizedPresetName)
Parameters
Type Name Description
RoundStartAttemptEvent ev
System.String localizedPresetName
Returns
Type Description
System.Boolean
| Improve this Doc View Source

Update(Single)

Declaration
public override void Update(float frameTime)
Parameters
Type Name Description
System.Single frameTime
  • Improve this Doc
  • View Source
☀
☾
In This Article
Back to top
Generated by DocFX
☀
☾