Show / Hide Table of Contents

Class WiresComponent

Inheritance
System.Object
WiresComponent
Namespace: Content.Server.Wires
Assembly: Content.Server.dll
Syntax
public sealed class WiresComponent : Component

Fields

| Improve this Doc View Source

PulseSound

Declaration
public SoundSpecifier PulseSound
Field Value
Type Description
Robust.Shared.Audio.SoundSpecifier

Properties

| Improve this Doc View Source

AlwaysRandomize

If this should follow the layout saved the first time the layout dictated by the layout ID is generated, or if a new wire order should be generated every time.

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

BoardName

The name of this entity's internal board.

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

LayoutId

The layout ID of this entity's wires.

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

SerialNumber

The serial number of this board. Randomly generated upon start, does not need to be set.

Declaration
public string? SerialNumber { get; set; }
Property Value
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

StateData

The state data for the set of wires inside of this entity. This is so that wire objects can be flyweighted between entities without any issues.

Declaration
public Dictionary<object, object> StateData { get; }
Property Value
Type Description
Dictionary<System.Object, System.Object>
| Improve this Doc View Source

Statuses

Per wire status, keyed by an object.

Declaration
public Dictionary<object, object> Statuses { get; }
Property Value
Type Description
Dictionary<System.Object, System.Object>
| Improve this Doc View Source

WireSeed

The seed that dictates the wires appearance, as well as the status ordering on the UI client side.

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

WiresList

The list of wires currently active on this entity.

Declaration
public List<Wire> WiresList { get; set; }
Property Value
Type Description
List<Wire>
| Improve this Doc View Source

WiresQueue

Queue of wires saved while the wire's DoAfter event occurs, to prevent too much spam.

Declaration
public List<int> WiresQueue { get; }
Property Value
Type Description
List<System.Int32>
  • Improve this Doc
  • View Source
☀
☾
In This Article
Back to top
Generated by DocFX
☀
☾