useritemmanager - TogetherGames/Public-Unity-CSharp GitHub Wiki

The UserItemManager is used for fetching and finding items that exist for the current user.

Stores all the UserItems contained in the Manager.

Adds a UserItem to the internally managed list without persistence.

Note
This method is deprecated

UserItemManager.Add( userItem )

UserItem userItem

Instance of a UserItem to add internally

Finds the UserItem with the specified UserItemID if it exists, otherwise returns null.

UserItemManager.FindByUserItemID( userItemID )

long userItemID

The ID of the UserItem to find

Gets the number of UserItems currently managed internally.

UserItemManager.GetCount(  )

Gets the UserItem at the specified index if it exists, otherwise returns null.

UserItemManager.Get( index )

int index

The index of the UserItem to find

Returns the index of the specified UserItem if it exists, otherwise returns -1.

UserItemManager.IndexOf( userItem )

UserItem userItem

Instance of the UserItem to find the index of

Returns the index of the UserItem with the specified UserItemID if it exists, otherwise returns -1.

UserItemManager.IndexOfByUserItemID( userItemID )

long userItemID

The ID of the UserItem to find the index of

Removes a UserItem from the internally managed list. This does not delete the user item from the user's account persistently.

Note
This method is deprecated

UserItemManager.Remove( index )

int index

The index of the UserItem to remove internally

Does a one for one copy of the user items contained in the passed manager to this manager.

Note
This method is deprecated

UserItemManager.PopulateFrom( manager )

UserItemManager manager

The manager to copy from

Awards a UserItem. Upon success, this automatically updates the internal list.

UserItemManager.Award( itemID, roomID, userItemProperties, callbackFunc )

long itemID

The ID of the Item to award.

The ID of the Room the UserItem is being awarded in.

The properties to assign to the UserItem. Pass null to assign no properties.

The function to call upon completion.

Creates a UserItem. Upon success, this automatically updates the internal list.

UserItemManager.Create( itemID, roomID, userItemProperties, callbackFunc )

long itemID

The ID of the Item to create a UserItem from.

The ID of the Room the UserItem is being awarded in.

The properties to assign to the UserItem. Pass null to assign no properties.

The function to call upon completion.

Deletes a UserItem. Upon success, this automatically updates the internal list.

UserItemManager.Delete( userItemID, callbackFunc )

long userItemID

The ID of the UserItem to delete.

The function to call upon completion.

Gets all UserItems assigned to the User. Upon success, this automatically updates the internal list.

UserItemManager.GetAll( callbackFunc )

OnCompleteHandler callbackFunc

The function to call upon completion.

Purchases a UserItem. Upon success, this automatically updates the internal list.

UserItemManager.Purchase( itemID, roomID, userItemProperties, callbackFunc )

long itemID

The ID of the Item to purchase.

The ID of the Room the UserItem is being awarded in.

The properties to assign to the UserItem. Pass null to assign no properties.

The function to call upon completion.

Sells a UserItem. Upon success, this automatically updates the internal list.

UserItemManager.Sell( userItemID, callbackFunc )

long userItemID

The ID of the UserItem to sell.

The function to call upon completion.