Interface IConnectionInfoProvider

Namespace

Archipelago.MultiClient.Net.Helpers

Assembly

Archipelago.MultiClient.Net.dll

Provides information about your current connection

public interface IConnectionInfoProvider

Properties

Game

The game you are connected to or an empty string otherwise

string Game { get; }

Property Value

string

ItemsHandlingFlags

The Item Handling Flags which your connection is currently using, defaults to NoItems

ItemsHandlingFlags ItemsHandlingFlags { get; }

Property Value

ItemsHandlingFlags

Slot

The slot you are connected to or -1 otherwise

int Slot { get; }

Property Value

int

Tags

The tags under which you client is connected or an empty array otherwise

string[] Tags { get; }

Property Value

string[]

Team

The team you are connected to or -1 otherwise

int Team { get; }

Property Value

int

Uuid

The Uniquely Identifiable string under which you client is connected or an empty string otherwise

string Uuid { get; }

Property Value

string

Methods

UpdateConnectionOptions(ItemsHandlingFlags)

Send a ConnectUpdate packet and set the tags and ItemsHandlingFlags for the current connection to the provided params.

void UpdateConnectionOptions(ItemsHandlingFlags itemsHandlingFlags)

Parameters

itemsHandlingFlags ItemsHandlingFlags

New ItemsHandlingFlags for the current connection.

UpdateConnectionOptions(string[])

Send a ConnectUpdate packet and set the tags and ItemsHandlingFlags for the current connection to the provided params.

void UpdateConnectionOptions(string[] tags)

Parameters

tags string[]

New tags for the current connection.

UpdateConnectionOptions(string[], ItemsHandlingFlags)

Send a ConnectUpdate packet and set the tags and ItemsHandlingFlags for the current connection to the provided params.

void UpdateConnectionOptions(string[] tags, ItemsHandlingFlags itemsHandlingFlags)

Parameters

tags string[]

New tags for the current connection.

itemsHandlingFlags ItemsHandlingFlags

New ItemsHandlingFlags for the current connection.