Class ServerInfo

Namespace

RustPlusApi.Data

Assembly

RustPlusApi.dll

Server metadata returned by GetInfoAsync.

public sealed record ServerInfo : IEquatable<ServerInfo>

Inheritance

object

ServerInfo

Implements

IEquatable<ServerInfo>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

CamerasEnabled

Whether the server allows CCTV camera access through the companion app, or null if the server is too old to report it.

public bool? CamerasEnabled { get; init; }

Property Value

bool?

HeaderImage

URL of the server's header/banner image.

public string? HeaderImage { get; init; }

Property Value

string

LogoImage

URL of the server's logo image.

public string? LogoImage { get; init; }

Property Value

string

Map

Map procedural seed name (e.g. Barren, HapisIsland, or the seed number).

public string? Map { get; init; }

Property Value

string

MapSize

Size of the map in game units.

public uint? MapSize { get; init; }

Property Value

uint?

MaxPlayerCount

Maximum number of players the server allows.

public uint? MaxPlayerCount { get; init; }

Property Value

uint?

Name

Display name of the server.

public string? Name { get; init; }

Property Value

string

Nexus

Nexus cluster identifier, if the server participates in a Nexus.

public string? Nexus { get; init; }

Property Value

string

NexusId

Numeric Nexus identifier, if the server participates in a Nexus.

public int? NexusId { get; init; }

Property Value

int?

NexusZone

Zone identifier within the Nexus cluster.

public string? NexusZone { get; init; }

Property Value

string

PlayerCount

Number of players currently connected.

public uint? PlayerCount { get; init; }

Property Value

uint?

QueuedPlayerCount

Number of players currently in the connection queue.

public uint? QueuedPlayerCount { get; init; }

Property Value

uint?

Salt

Procedural map generation salt.

public uint? Salt { get; init; }

Property Value

uint?

Seed

Procedural map generation seed.

public uint? Seed { get; init; }

Property Value

uint?

Url

URL of the server's website or information page.

public string? Url { get; init; }

Property Value

string

WipeTime

UTC time of the last forced wipe.

public DateTime? WipeTime { get; init; }

Property Value

DateTime?