Interface IRoomStateHelper

Namespace

Archipelago.MultiClient.Net.Helpers

Assembly

Archipelago.MultiClient.Net.dll

Provides information about the current state of the server

public interface IRoomStateHelper

Properties

CollectPermissions

An enumeration containing the possible collect command permission.

Permissions CollectPermissions { get; }

Property Value

Permissions

ForfeitPermissions

An enumeration containing the possible forfeit command permission. Deprecated, use Release Permissions instead

Permissions ForfeitPermissions { get; }

Property Value

Permissions

GeneratorVersion

The version of Archipelago which generated the multiworld.

Version GeneratorVersion { get; }

Property Value

Version

HasPassword

Denoted whether a password is required to join this room.

bool HasPassword { get; }

Property Value

bool

HintCost

The amount of points it costs to receive a hint from the server.

int HintCost { get; }

Property Value

int

HintCostPercentage

The percentage of total locations that need to be checked to receive a hint from the server.

int HintCostPercentage { get; }

Property Value

int

HintPoints

The client's current hint points.

int HintPoints { get; }

Property Value

int

LocationCheckPoints

The amount of hint points you receive per item/location check completed.

int LocationCheckPoints { get; }

Property Value

int

ReleasePermissions

An enumeration containing the possible release command permission.

Permissions ReleasePermissions { get; }

Property Value

Permissions

RemainingPermissions

An enumeration containing the possible remaining command permission.

Permissions RemainingPermissions { get; }

Property Value

Permissions

RoomInfoSendTime

Time stamp of we first connected to the server, and the server send us the RoomInfoPacker. Send for time synchronization if wanted for things like the DeathLink Bounce.

DateTime RoomInfoSendTime { get; }

Property Value

DateTime

Seed

Uniquely identifying name of this generation

string Seed { get; }

Property Value

string

ServerTags

Denotes special features or capabilities that the server is capable of.

ReadOnlyCollection<string> ServerTags { get; }

Property Value

ReadOnlyCollection<string>

Version

The version of Archipelago which the server is running.

Version Version { get; }

Property Value

Version