Class ItemInfo

Namespace

Archipelago.MultiClient.Net.Models

Assembly

Archipelago.MultiClient.Net.dll

Information about an item and its location

public class ItemInfo

Inheritance

object

ItemInfo

Derived

ScoutedItemInfo

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

ItemInfo(NetworkItem, string, string, IItemInfoResolver, PlayerInfo)

The constructor what else did you expect it to be

public ItemInfo(NetworkItem item, string receiverGame, string senderGame, IItemInfoResolver itemInfoResolver, PlayerInfo player)

Parameters

item NetworkItem

receiverGame string

senderGame string

itemInfoResolver IItemInfoResolver

player PlayerInfo

Properties

Flags

Enum flags that describe special properties of the Item

public ItemFlags Flags { get; }

Property Value

ItemFlags

ItemDisplayName

The name of the item for display purposes, returns a fallback string containing the ItemId if the name cannot be resolved

public string ItemDisplayName { get; }

Property Value

string

ItemGame

The game the item belongs to

public string ItemGame { get; }

Property Value

string

ItemId

The item id of the item. Item ids are in the range of ± (2^53)-1.

public long ItemId { get; }

Property Value

long

ItemName

The name of the item, null if the name cannot be resolved

public string ItemName { get; }

Property Value

string

LocationDisplayName

The name of the location for display purposes, returns a fallback string containing the LocationId if the name cannot be resolved

public string LocationDisplayName { get; }

Property Value

string

LocationGame

The game the location belongs to

public string LocationGame { get; }

Property Value

string

LocationId

The location id of the item inside the world. Location ids are in the range of ± (2^53)-1.

public long LocationId { get; }

Property Value

long

LocationName

The name of the location that item is at, null if the name cannot be resolved

public string LocationName { get; }

Property Value

string

Player

The player of the world the item is located in

public PlayerInfo Player { get; }

Property Value

PlayerInfo

Methods

ToSerializable()

Converts this ItemInfo in to a serializable class that can be converted from and to json

public SerializableItemInfo ToSerializable()

Returns

SerializableItemInfo

an SerializableItemInfo containing all the inforation of the ItemInfo it was created with