Class BaseWireAction

IWireAction

Inheritance
System.Object
BaseWireAction
PowerWireAction
BaseToggleWireAction
ComponentWireAction<TComponent>
Implements
Namespace: Content.Server.Wires
Assembly: Content.Server.dll
Syntax
public abstract class BaseWireAction : object, IWireAction

Fields

| Improve this Doc View Source

EntityManager

Declaration
public IEntityManager EntityManager
Field Value
Type Description
IEntityManager
| Improve this Doc View Source

WiresSystem

Declaration
public WiresSystem WiresSystem
Field Value
Type Description
WiresSystem

Properties

| Improve this Doc View Source

Color

Default color that gets returned by GetStatusLightData(Wire).

Declaration
public abstract Color Color { get; set; }
Property Value
Type Description
Color
| Improve this Doc View Source

LightRequiresPower

If true, the default behavior of GetStatusLightData(Wire) will return an off-light when the wire owner is not powered.

Declaration
public virtual bool LightRequiresPower { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

Name

The loc-string of the text that gets returned by GetStatusLightData(Wire). Also used for admin logging.

Declaration
public abstract string Name { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

StatusKey

Declaration
public abstract object? StatusKey { get; }
Property Value
Type Description
System.Nullable<System.Object>

Methods

| Improve this Doc View Source

AddWire(Wire, Int32)

Declaration
public virtual bool AddWire(Wire wire, int count)
Parameters
Type Name Description
Wire wire
System.Int32 count
Returns
Type Description
System.Boolean
| Improve this Doc View Source

Cut(EntityUid, Wire)

Declaration
public virtual bool Cut(EntityUid user, Wire wire)
Parameters
Type Name Description
EntityUid user
Wire wire
Returns
Type Description
System.Boolean
| Improve this Doc View Source

GetLightState(Wire)

Declaration
public virtual StatusLightState? GetLightState(Wire wire)
Parameters
Type Name Description
Wire wire
Returns
Type Description
System.Nullable<StatusLightState>
| Improve this Doc View Source

GetStatusLightData(Wire)

Declaration
public virtual StatusLightData? GetStatusLightData(Wire wire)
Parameters
Type Name Description
Wire wire
Returns
Type Description
System.Nullable<StatusLightData>
| Improve this Doc View Source

Initialize()

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

IsPowered(EntityUid)

Utility function to check if this given entity is powered.

Declaration
protected bool IsPowered(EntityUid uid)
Parameters
Type Name Description
EntityUid uid
Returns
Type Description
System.Boolean

true if powered, false otherwise
| Improve this Doc View Source

Mend(EntityUid, Wire)

Declaration
public virtual bool Mend(EntityUid user, Wire wire)
Parameters
Type Name Description
EntityUid user
Wire wire
Returns
Type Description
System.Boolean
| Improve this Doc View Source

Pulse(EntityUid, Wire)

Declaration
public virtual void Pulse(EntityUid user, Wire wire)
Parameters
Type Name Description
EntityUid user
Wire wire
| Improve this Doc View Source

Update(Wire)

Declaration
public virtual void Update(Wire wire)
Parameters
Type Name Description
Wire wire

Implements