userachievement - TogetherGames/Public-Unity-CSharp GitHub Wiki

UserAchievement

Together::UserAchievement

Overview

The UserAchievement class represents a Achievement belonging to a User


Members

long UserAchievementID

The ID of the UserAchievement.

long RoomID

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

int RequiredCount

The number of times the UserAchievement has been accomplished. If this value is less than the base Achievement's RequiredCount, then the UserAchievement has only been partially accomplished.

bool Completed

A boolean indicating whether the UserAchievement has been fully accomplished. Please see RequiredCount parameter description.

Achievement Achievement

The base Achievement that the UserAchievement is essentially an instance of.

PropertyCollection Properties

A property collection containing all custom properties for the UserAchievement.


Methods


Modify()

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

Returns void
Syntax
UserAchievement.Modify( callbackFunc )
Parameters

OnCompleteHandler callbackFunc

The function to call upon completion.

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