useritemmanager - TogetherGames/Public-Corona-Lua 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 )

TogetherUserItem userItem

Instance of a UserItem to add internally

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

UserItemManager:FindByUserItemID( userItemID )

number 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 nil.

UserItemManager:Get( index )

number index

The index of the UserItem to retrieve.

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

UserItemManager:IndexOf( userItem )

TogetherUserItem 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 )

number 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 )

number index

The index of the UserItem to remove internally

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

Note
Rooms are deprecated and the roomID has no effect at this time

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

number itemID

The ID of the Item to award.

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

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

The function to call upon completion.

Creates a UserItem.

Note
Rooms are deprecated and the roomID has no effect at this time

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

number itemID

The ID of the Item to create a UserItem from.

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

The properties to assign to the UserItem. Pass nil 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 )

number 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 )

function callbackFunc

The function to call upon completion.

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

Note
Rooms are deprecated and the roomID has no effect at this time

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

number itemID

The ID of the Item to purchase.

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

The properties to assign to the UserItem. Pass nil 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 )

number userItemID

The ID of the UserItem to sell.

The function to call upon completion.