Class CollectionModule

Provides utility methods for working with collection states in the world state.

public static class CollectionModule

Inherited Members: object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

Get the CollectionState for a given address from the world state.

public static CollectionState GetCollectionState(this IWorldState worldState, Address address)

FailedLoadStateException: Thrown when the Collection state for the given address is not found in the world state.
InvalidCastException: Thrown when the serialized Collection state is not in the correct format.

Retrieves the collection states for the given addresses from the world state.

public static Dictionary<Address, CollectionState> GetCollectionStates(this IWorldState worldState, IReadOnlyList<Address> addresses)

worldState IWorldState: The world state used to retrieve the collection states.
addresses IReadOnlyList<Address>: The list of addresses to retrieve the collection states for.

Dictionary<Address, CollectionState>: A dictionary of Address and CollectionState pairs representing the collection states for the given addresses, or an empty dictionary for addresses that do not have a collection state.

Sets the state of a collection in the world.

public static IWorld SetCollectionState(this IWorld world, Address collection, CollectionState state)

Tries to get the collection state for a specific address from the given world state.

public static bool TryGetCollectionState(this IWorldState worldState, Address address, out CollectionState collectionState)

worldState IWorldState: The world state from which to get the collection state.
address Address: The address for which to retrieve the collection state.
collectionState CollectionState: The resulting collection state, if found.