RepoMirrors
/
osu
mirror of https://github.com/ppy/osu
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add xmldoc mention of valid `OnlineID` values

This commit is contained in:
Dean Herbert 2021-10-20 15:24:27 +09:00
parent c8cdc38efd
commit da750a74fc
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
osu.Game/Database/IHasOnlineID.cs
View File

@ -8,8 +8,12 @@ namespace osu.Game.Database
public interface IHasOnlineID public interface IHasOnlineID
{ {
/// <summary> /// <summary>
/// The server-side ID representing this instance, if one exists. -1 denotes a missing ID. /// The server-side ID representing this instance, if one exists. Any value 0 or less denotes a missing ID.
/// </summary> /// </summary>
/// <remarks>
/// Generally we use -1 when specifying "missing" in code, but values of 0 are also considered missing as the online source
/// is generally a MySQL autoincrement value, which can never be 0.
/// </remarks>
int OnlineID { get; } int OnlineID { get; }
} }
} }