Show / Hide Table of Contents

Class DeviceNetworkComponent

Inheritance
System.Object
DeviceNetworkComponent
Namespace: Content.Server.DeviceNetwork.Components
Assembly: Content.Server.dll
Syntax
public sealed class DeviceNetworkComponent : Component

Fields

| Improve this Doc View Source

Address

The address of the device, either on the network it is currently connected to or whatever address it most recently used.

Declaration
public string Address
Field Value
Type Description
System.String
| Improve this Doc View Source

AutoConnect

Whether the device should attempt to join the network on map init.

Declaration
public bool AutoConnect
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

CustomAddress

If true, the address was customized and should be preserved across networks. If false, a randomly generated address will be created whenever this device connects to a network.

Declaration
public bool CustomAddress
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

ExaminableAddress

If the device should show its address upon an examine. Useful for devices that do not have a visible UI.

Declaration
public bool ExaminableAddress
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

Prefix

Prefix to prepend to any automatically generated addresses. Helps players to identify devices. This gets localized.

Declaration
public string? Prefix
Field Value
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

ReceiveAll

Whether the device should listen for all device messages, regardless of the intended recipient.

Declaration
public bool ReceiveAll
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

ReceiveFrequency

The frequency that this device is listening on.

Declaration
public uint? ReceiveFrequency
Field Value
Type Description
System.Nullable<System.UInt32>
| Improve this Doc View Source

ReceiveFrequencyId

frequency prototype. Used to select a default frequency to listen to on. Used when the map is initialized.

Declaration
public string? ReceiveFrequencyId
Field Value
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

SendBroadcastAttemptEvent

Whether to send the broadcast recipients list to the sender so it can be filtered. DeviceListSystem

Declaration
public bool SendBroadcastAttemptEvent
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

ShutdownSubscribers

A list of entities that get sent the Content.Server.DeviceNetwork.Systems.DeviceShutDownEvent when this entity gets deleted.

When a device subscribes to the deletion of another device the entity id of the device being subscribed to also gets saved on the subscribing device.

Declaration
public HashSet<EntityUid> ShutdownSubscribers
Field Value
Type Description
HashSet<EntityUid>
| Improve this Doc View Source

TransmitFrequency

The frequency that this device going to try transmit on.

Declaration
public uint? TransmitFrequency
Field Value
Type Description
System.Nullable<System.UInt32>
| Improve this Doc View Source

TransmitFrequencyId

frequency prototype. Used to select a default frequency to transmit on. Used when the map is initialized.

Declaration
public string? TransmitFrequencyId
Field Value
Type Description
System.Nullable<System.String>

Properties

| Improve this Doc View Source

DeviceNetId

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

NetIdEnum

Declaration
public DeviceNetworkComponent.DeviceNetIdDefaults NetIdEnum { get; set; }
Property Value
Type Description
DeviceNetworkComponent.DeviceNetIdDefaults
  • Improve this Doc
  • View Source
☀
☾
In This Article
Back to top
Generated by DocFX
☀
☾