Table of Contents

Interface IItemInfoResolver

Namespace
Archipelago.MultiClient.Net.DataPackage
Assembly
Archipelago.MultiClient.Net.dll

Provides methods to resolve item additional information based on ideez

public interface IItemInfoResolver

Methods

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 itemId, string game = null)

Parameters

itemId 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.

GetLocationId(string, string)

Get the Id of a location from its name. Useful when a game knows its locations by name but not by Archipelago Id.

long GetLocationId(string locationName, string game = null)

Parameters

locationName string

The name of the location to check the Id for. Must match the contents of the datapackage.

game string

The game to look up the locations from

Returns

long

Returns the locationId for the location name that was given or -1 if no location was found.

GetLocationName(long, string)

Get the name of a location from its id. Useful when receiving a packet and it is necessary to find the name of the location.

string GetLocationName(long locationId, string game = null)

Parameters

locationId long

The Id of the location to look up the name for. Must match the contents of the datapackage.

game string

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

Returns

string

Returns the locationName for the provided locationId, or null if no such location is found.