| BrainCloudServiceClientPlayerStatistics_IncrementUserStats_SSFOAsync Method |
[This is preliminary documentation and is subject to change.]
Atomically increment (or decrement) user statistics.
Any rewards that are triggered from user statistic increments
will be considered. User statistics are defined through the brainCloud portal.
Note also that the "xpCapped" property is returned (true/false depending on whether
the xp cap is turned on and whether the user has hit it).
Namespace:
Ruyi.SDK.BrainCloudApi
Assembly:
SDK.Gen.ServiceAsync (in SDK.Gen.ServiceAsync.dll) Version: 0.9.3.3995
Syntax public Task<string> PlayerStatistics_IncrementUserStats_SSFOAsync(
string jsonData,
int clientIndex,
CancellationToken cancellationToken
)
Parameters
- jsonData
- Type: SystemString
The JSON encoded data to be sent to the server as follows:
{
stat1: 10,
stat2: -5.5,
}
would increment stat1 by 10 and decrement stat2 by 5.5.
For the full statistics grammer see the api.braincloudservers.com site.
There are many more complex operations supported such as:
{
stat1:INC_TO_LIMIT#9#30
}
which increments stat1 by 9 up to a limit of 30. - clientIndex
- Type: SystemInt32
@BrainCloud_clientIndex_desc - cancellationToken
- Type: System.ThreadingCancellationToken
[Missing <param name="cancellationToken"/> documentation for "M:Ruyi.SDK.BrainCloudApi.BrainCloudService.Client.PlayerStatistics_IncrementUserStats_SSFOAsync(System.String,System.Int32,System.Threading.CancellationToken)"]
Return Value
Type:
TaskString[Missing <returns> documentation for "M:Ruyi.SDK.BrainCloudApi.BrainCloudService.Client.PlayerStatistics_IncrementUserStats_SSFOAsync(System.String,System.Int32,System.Threading.CancellationToken)"]
See Also