useritem - TogetherGames/Public-Unity-CSharp GitHub Wiki

UserItem

Together::UserItem

Overview

The UserItem class represents an Item belonging to the User's account.


Members

long UserItemID

The ID of the UserItem.

long RoomID

The ID of the Room the UserItem was created in. If equal to 0, then the UserItem wasn't created in a room.

Item Item

The base Item that the UserItem is essentially an instance of.

PropertyCollection Properties

A property collection containing all custom properties for the UserItem.


Methods


Modify()

Modifies the UserItem. Upon success, this will automatically update the internal data. The UserItemID and Properties members are sent to the server when this method is called.

Returns void
Syntax
UserItem.Modify( callbackFunc )
Parameters

OnCompleteHandler callbackFunc

The function to call upon completion.

--------------------------------------------------------------------------------
⚠️ **GitHub.com Fallback** ⚠️