Class AtmosAlarmableSystem

Inheritance
System.Object
AtmosAlarmableSystem
Namespace: Content.Server.Atmos.Monitor.Systems
Assembly: Content.Server.dll
Syntax
public sealed class AtmosAlarmableSystem : EntitySystem

Fields

| Improve this Doc View Source

AlertCmd

An alarm. Has three valid states: Normal, Warning, Danger. Will attempt to fetch the tags from the alarming entity to send over.

Declaration
public const string AlertCmd = null
Field Value
Type Description
System.String
| Improve this Doc View Source

AlertSource

Declaration
public const string AlertSource = null
Field Value
Type Description
System.String
| Improve this Doc View Source

AlertTypes

Declaration
public const string AlertTypes = null
Field Value
Type Description
System.String
| Improve this Doc View Source

ResetAll

Declaration
public const string ResetAll = null
Field Value
Type Description
System.String
| Improve this Doc View Source

SyncAlerts

Syncs alerts from this alarm receiver to other alarm receivers. Creates a network effect as a result. Note: if the alert receiver is not aware of the device beforehand, it will not sync.

Declaration
public const string SyncAlerts = null
Field Value
Type Description
System.String

Methods

| Improve this Doc View Source

ForceAlert(EntityUid, AtmosAlarmType, AtmosAlarmableComponent, DeviceNetworkComponent, TagComponent)

Forces this alarmable to have a specific alert. This will not be reset until the alarmable is manually reset. This will store the alarmable as a device in its network states.

Declaration
public void ForceAlert(EntityUid uid, AtmosAlarmType alarmType, AtmosAlarmableComponent alarmable = null, DeviceNetworkComponent devNet = null, TagComponent tags = null)
Parameters
Type Name Description
EntityUid uid
AtmosAlarmType alarmType
AtmosAlarmableComponent alarmable
DeviceNetworkComponent devNet
TagComponent tags
| Improve this Doc View Source

Initialize()

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

Reset(EntityUid, AtmosAlarmableComponent, TagComponent)

Resets the state of this alarmable to normal.

Declaration
public void Reset(EntityUid uid, AtmosAlarmableComponent alarmable = null, TagComponent tags = null)
Parameters
Type Name Description
EntityUid uid
AtmosAlarmableComponent alarmable
TagComponent tags
| Improve this Doc View Source

ResetAllOnNetwork(EntityUid, AtmosAlarmableComponent)

Declaration
public void ResetAllOnNetwork(EntityUid uid, AtmosAlarmableComponent alarmable = null)
Parameters
Type Name Description
EntityUid uid
AtmosAlarmableComponent alarmable
| Improve this Doc View Source

SyncAlertsToNetwork(EntityUid, Nullable<String>, AtmosAlarmableComponent, TagComponent)

Declaration
public void SyncAlertsToNetwork(EntityUid uid, string? address = null, AtmosAlarmableComponent alarmable = null, TagComponent tags = null)
Parameters
Type Name Description
EntityUid uid
System.Nullable<System.String> address
AtmosAlarmableComponent alarmable
TagComponent tags
| Improve this Doc View Source

TryGetHighestAlert(EntityUid, out Nullable<AtmosAlarmType>, AtmosAlarmableComponent)

Tries to get the highest possible alert stored in this alarm.

Declaration
public bool TryGetHighestAlert(EntityUid uid, out AtmosAlarmType? alarm, AtmosAlarmableComponent alarmable = null)
Parameters
Type Name Description
EntityUid uid
System.Nullable<AtmosAlarmType> alarm
AtmosAlarmableComponent alarmable
Returns
Type Description
System.Boolean