Interface IReceivedItemsHelper

Namespace

Archipelago.MultiClient.Net.Helpers

Assembly

Archipelago.MultiClient.Net.dll

Provides simplified methods to receive items

public interface IReceivedItemsHelper

Properties

AllItemsReceived

Full list of all items received

ReadOnlyCollection<ItemInfo> AllItemsReceived { get; }

Property Value

ReadOnlyCollection<ItemInfo>

Index

Total number of items received

int Index { get; }

Property Value

int

Methods

Any()

Check whether there are any items in the queue.

bool Any()

Returns

bool

True if the queue is not empty, otherwise false.

DequeueItem()

Dequeues and returns the next item on the queue to be handled.

ItemInfo DequeueItem()

Returns

ItemInfo

The next item to be handled as a NetworkItem.

Exceptions

InvalidOperationException

The Queue<T> is empty.

GetItemName(long, string)

Perform a lookup using the DataPackage sent as a source of truth to lookup a particular item id for a particular game.

string GetItemName(long id, string game = null)

Parameters

id long

Id of the item to lookup.

game string

The game to lookup the item id for, if null will look in the game the local player is connected to. Negative item ids are always looked up under the Archipelago game

Returns

string

The name of the item as a string, or null if no such item is found.

PeekItem()

Peek the next item on the queue to be handled. The item will remain on the queue until dequeued with DequeueItem().

ItemInfo PeekItem()

Returns

ItemInfo

The next item to be handled as a NetworkItem, or null if no such item is found.

Exceptions

InvalidOperationException

The Queue<T> is empty.

Events

ItemReceived

Event triggered when an item is received. fires once for each item received

event ReceivedItemsHelper.ItemReceivedHandler ItemReceived

Event Type

ReceivedItemsHelper.ItemReceivedHandler