Class Store

Maintains Collection of BaseTransaction items for a Store and implements methods to retrieve them.

Inheritance

Object

CatalogItem

Store

Inherited Members

CatalogItem.displayName

CatalogItem.key

CatalogItem.GetTags(ICollection<Tag>, Boolean)

CatalogItem.HasTag(Tag)

CatalogItem.GetHashCode()

CatalogItem.Equals(Object)

CatalogItem.GetStaticProperties()

CatalogItem.GetStaticProperties(Dictionary<String, Property>)

CatalogItem.HasStaticProperty(String)

CatalogItem.GetStaticProperty(String)

CatalogItem.TryGetStaticProperty(String, Property)

CatalogItem.Item[String]

Namespace: UnityEngine.GameFoundation

Syntax

public class Store : CatalogItem, IEquatable<CatalogItem>, IComparable<CatalogItem>

Methods

Contains(BaseTransaction)

Tells whether or not this Store instance contains the given transaction.

Declaration

public bool Contains(BaseTransaction transaction)

Parameters

Type	Name	Description
BaseTransaction	transaction	The BaseTransaction instance to find.

Returns

Type	Description
Boolean	true if found, false otherwise.

FindStoreItems(IEnumerable<Tag>, ICollection<BaseTransaction>, Boolean)

Updates Collection of all BaseTransaction items in this Store with any of the specified Tag set.

Declaration

public int FindStoreItems(IEnumerable<Tag> tags, ICollection<BaseTransaction> target = null, bool clearTarget = true)

Parameters

Type	Name	Description
IEnumerable<Tag>	tags	Collection of desired Tag to be added to the output Collection.
ICollection<BaseTransaction>	target	Collection to place resultant BaseTransaction items into.
Boolean	clearTarget	If true, it clears the target collection before populating.

Returns

Type	Description
Int32	The number of BaseTransaction items found.

Exceptions

Type	Condition
ArgumentNullException	Throws if tags or target is null.
ArgumentException	Throws if any Tag in tags Collection is null.

FindStoreItems(Tag, ICollection<BaseTransaction>, Boolean)

Adds all BaseTransaction items in this Store with specified Tag set to Collection.

Declaration

public int FindStoreItems(Tag tag, ICollection<BaseTransaction> target = null, bool clearTarget = true)

Parameters

Type	Name	Description
Tag	tag	Desired Tag to be queried by this method.
ICollection<BaseTransaction>	target	Collection to place resultant BaseTransaction items into.
Boolean	clearTarget	If true, it clears the target collection before populating.

Returns

Type	Description
Int32	The number of BaseTransaction items added.

Exceptions

Type	Condition
ArgumentNullException	Throws if tag is null.

GetStoreItems(ICollection<BaseTransaction>, Boolean)

Gets all the store items (BaseTransaction instances).

Declaration

public int GetStoreItems(ICollection<BaseTransaction> target = null, bool clearTarget = true)

Parameters

Type	Name	Description
ICollection<BaseTransaction>	target	The target collection store items are copied to.
Boolean	clearTarget	If true, it clears the target collection before populating.

Returns

Type	Description
Int32	The number of items of this store.

ToString()

Returns a summary string for this Store.

Declaration

public override string ToString()

Returns

Type	Description
String	Summary string for this Store.

Overrides

Object.ToString()