Add an explanatory note to GetSteamAccountID

This commit is contained in:
Asher Baker 2017-08-12 13:04:26 +01:00 committed by GitHub
parent aeb52d4f45
commit 01c6bb8c6f

View File

@ -317,7 +317,8 @@ native bool GetClientAuthString(int client, char[] auth, int maxlen, bool valida
native bool GetClientAuthId(int client, AuthIdType authType, char[] auth, int maxlen, bool validate=true); native bool GetClientAuthId(int client, AuthIdType authType, char[] auth, int maxlen, bool validate=true);
/** /**
* Returns the client's Steam account ID. * Returns the client's Steam account ID, a number uniquely identifying a given Steam account.
* This number is the basis for the various display SteamID forms, see the AuthIdType enum for examples.
* *
* @param client Client Index. * @param client Client Index.
* @param validate Check backend validation status. * @param validate Check backend validation status.