Interface IArchipelagoSession

Namespace

Archipelago.MultiClient.Net

Assembly

Archipelago.MultiClient.Net.dll

ArchipelagoSession is the overarching class to access and modify and respond to the multiworld state

public interface IArchipelagoSession : IArchipelagoSessionActions

Inherited Members

IArchipelagoSessionActions.Say(string)

IArchipelagoSessionActions.SetClientState(ArchipelagoClientState)

IArchipelagoSessionActions.SetGoalAchieved()

Properties

ConnectionInfo

Provides information about your current connection

IConnectionInfoProvider ConnectionInfo { get; }

Property Value

IConnectionInfoProvider

DataStorage

Provides access to a server side data storage to share and store values across sessions and players

IDataStorageHelper DataStorage { get; }

Property Value

IDataStorageHelper

Items

Provides simplified methods to receive items

IReceivedItemsHelper Items { get; }

Property Value

IReceivedItemsHelper

Locations

Provides way to mark locations as checked

ILocationCheckHelper Locations { get; }

Property Value

ILocationCheckHelper

MessageLog

Provides simplified handlers to receive messages about events that happen in the multiworld

IMessageLogHelper MessageLog { get; }

Property Value

IMessageLogHelper

Players

Provides information about all players in the multiworld

IPlayerHelper Players { get; }

Property Value

IPlayerHelper

RoomState

Provides information about the current state of the server

IRoomStateHelper RoomState { get; }

Property Value

IRoomStateHelper

Socket

Provides access to the underlying websocket, so send or receive messages

IArchipelagoSocketHelper Socket { get; }

Property Value

IArchipelagoSocketHelper

Methods

TryConnectAndLogin(string, string, ItemsHandlingFlags, Version, string[], string, string, bool)

Attempt to log in to the Archipelago server by opening a websocket connection and sending a Connect packet. Determining success for this attempt is done by attaching a listener to Socket.PacketReceived and listening for a Connected packet.

LoginResult TryConnectAndLogin(string game, string name, ItemsHandlingFlags itemsHandlingFlags, Version version = null, string[] tags = null, string uuid = null, string password = null, bool requestSlotData = true)

Parameters

game string

The game this client is playing.

name string

The slot name of this client.

itemsHandlingFlags ItemsHandlingFlags

Informs the AP server how you want ReceivedItem packets to be sent to you.

version Version

The minimum AP protocol version this client supports.

tags string[]

The tags this client supports.

uuid string

The uuid of this client.

password string

The password to connect to this AP room.

requestSlotData bool

Decides if the LoginSuccessful result will contain any slot data

Returns

LoginResult

LoginSuccessful if the connection is succeeded and the server accepted the login attempt. LoginFailure if the connection to the server failed in some way.

Remarks

The connect attempt is synchronous and will lock for up to 5 seconds as it attempts to connect to the server. Most connections are instantaneous however the timeout is 5 seconds before it returns LoginFailure.