Class WiresSystem

Inheritance
System.Object
SharedWiresSystem
WiresSystem
Namespace: Content.Server.Wires
Assembly: Content.Server.dll
Syntax
public sealed class WiresSystem : SharedWiresSystem

Methods

| Improve this Doc View Source

ChangePanelVisibility(EntityUid, WiresPanelComponent, Boolean)

Declaration
public void ChangePanelVisibility(EntityUid uid, WiresPanelComponent component, bool visible)
Parameters
Type Name Description
EntityUid uid
WiresPanelComponent component
System.Boolean visible
| Improve this Doc View Source

HasData(EntityUid, Object, WiresComponent)

If this entity has data stored via this key in the WiresComponent it has

Declaration
public bool HasData(EntityUid uid, object identifier, WiresComponent wires = null)
Parameters
Type Name Description
EntityUid uid
System.Object identifier
WiresComponent wires
Returns
Type Description
System.Boolean
| Improve this Doc View Source

Initialize()

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

OpenUserInterface(EntityUid, IPlayerSession)

Declaration
public void OpenUserInterface(EntityUid uid, IPlayerSession player)
Parameters
Type Name Description
EntityUid uid
Robust.Server.Player.IPlayerSession player
| Improve this Doc View Source

RemoveData(EntityUid, Object, WiresComponent)

Removes data from this entity stored in the given key from the entity's WiresComponent.

Declaration
public void RemoveData(EntityUid uid, object identifier, WiresComponent wires = null)
Parameters
Type Name Description
EntityUid uid
System.Object identifier

The key that stores the data in the WiresComponent.
WiresComponent wires
| Improve this Doc View Source

SetData(EntityUid, Object, Object, WiresComponent)

Sets data in the entity's WiresComponent state dictionary by key.

Declaration
public void SetData(EntityUid uid, object identifier, object data, WiresComponent wires = null)
Parameters
Type Name Description
EntityUid uid
System.Object identifier

The key that stores the data in the WiresComponent.
System.Object data

The data to store using the given identifier.
WiresComponent wires
| Improve this Doc View Source

SetWiresPanelSecurity(EntityUid, WiresPanelSecurityComponent, WiresPanelSecurityEvent)

Declaration
public void SetWiresPanelSecurity(EntityUid uid, WiresPanelSecurityComponent component, WiresPanelSecurityEvent args)
Parameters
Type Name Description
EntityUid uid
WiresPanelSecurityComponent component
WiresPanelSecurityEvent args
| Improve this Doc View Source

StartWireAction(EntityUid, Single, Object, TimedWireEvent)

Starts a timed action for this entity.

Declaration
public void StartWireAction(EntityUid owner, float delay, object key, TimedWireEvent onFinish)
Parameters
Type Name Description
EntityUid owner
System.Single delay

How long this takes to finish
System.Object key

The key used to cancel the action
TimedWireEvent onFinish

The event that is sent out when the wire is finished TimedWireEvent
| Improve this Doc View Source

TogglePanel(EntityUid, WiresPanelComponent, Boolean)

Declaration
public void TogglePanel(EntityUid uid, WiresPanelComponent component, bool open)
Parameters
Type Name Description
EntityUid uid
WiresPanelComponent component
System.Boolean open
| Improve this Doc View Source

TryCancelWireAction(EntityUid, Object)

Tries to cancel an active wire action via the given key that it's stored in.

Declaration
public bool TryCancelWireAction(EntityUid owner, object key)
Parameters
Type Name Description
EntityUid owner
System.Object key

The key used to cancel the action.
Returns
Type Description
System.Boolean
| Improve this Doc View Source

TryGetData<T>(EntityUid, Object, out T, WiresComponent)

Tries to get the stateful data stored in this entity's WiresComponent.

Declaration
public bool TryGetData<T>(EntityUid uid, object identifier, out T data, WiresComponent wires = null)
Parameters
Type Name Description
EntityUid uid
System.Object identifier

The key that stores the data in the WiresComponent.
T data
WiresComponent wires
Returns
Type Description
System.Boolean
Type Parameters
Name Description
T
| Improve this Doc View Source

TryGetWire(EntityUid, Int32, WiresComponent)

Tries to get a wire on this entity by its integer id.

Declaration
public Wire TryGetWire(EntityUid uid, int id, WiresComponent wires = null)
Parameters
Type Name Description
EntityUid uid
System.Int32 id
WiresComponent wires
Returns
Type Description
Wire

The wire if found, otherwise null
| Improve this Doc View Source

TryGetWires<T>(EntityUid, WiresComponent)

Tries to get all the wires on this entity by the wire action type.

Declaration
public IEnumerable<Wire> TryGetWires<T>(EntityUid uid, WiresComponent wires = null)
Parameters
Type Name Description
EntityUid uid
WiresComponent wires
Returns
Type Description
IEnumerable<Wire>

Enumerator of all wires in this entity according to the given type.
Type Parameters
Name Description
T
| Improve this Doc View Source

Update(Single)

Declaration
public override void Update(float frameTime)
Parameters
Type Name Description
System.Single frameTime