Class BaseToggleWireAction

Utility class meant to be implemented. This is to toggle a value whenever a wire is cut, mended, or pulsed.

Inheritance
System.Object
BaseWireAction
BaseToggleWireAction
ArcadeEnemyInvincibleWireAction
ArcadeOverflowWireAction
ArcadePlayerInvincibleWireAction
VendingMachineContrabandWireAction
Implements
Namespace: Content.Server.Wires
Assembly: Content.Server.dll
Syntax
public abstract class BaseToggleWireAction : BaseWireAction, IWireAction

Properties

| Improve this Doc View Source

Delay

Declaration
public virtual int Delay { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

TimeoutKey

Timeout key for the wire, if it is pulsed. If this is null, there will be no value revert after a given delay, otherwise, the value will be set to the opposite of what it currently is (according to GetValue)

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

Methods

| Improve this Doc View Source

Cut(EntityUid, Wire)

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

GetValue(EntityUid)

Gets the value on the given entity. An implementor is expected to handle the value getter properly.

Declaration
public abstract bool GetValue(EntityUid owner)
Parameters
Type Name Description
EntityUid owner
Returns
Type Description
System.Boolean
| Improve this Doc View Source

Mend(EntityUid, Wire)

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

Pulse(EntityUid, Wire)

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

ToggleValue(EntityUid, Boolean)

Toggles the value on the given entity. An implementor is expected to handle the value toggle appropriately.

Declaration
public abstract void ToggleValue(EntityUid owner, bool setting)
Parameters
Type Name Description
EntityUid owner
System.Boolean setting
| Improve this Doc View Source

Update(Wire)

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

Implements