leaderboardState: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Some wiki formatting)
m (Text replacement - "‎" to "")
 
(5 intermediate revisions by the same user not shown)
Line 6: Line 6:
|gr1= Leaderboards
|gr1= Leaderboards


|descr= returns state of the board with given name. 0: Busy (async. operation in progress); 1: Async. operation ended with success; 2: Async. operation ended with error; 3: Invalid board (bad board name, not initialized etc.).
|descr= Returns the state of the board with the given name.


|s1= [[leaderboardState]] boardname
|s1= [[leaderboardState]] boardname


|p1= boardname: [[String]] -
|p1= boardname: [[String]]


|r1= [[Number]]
|r1= [[Number]]
* 0: Busy (async. operation in progress)
* 1: Async. operation ended with success
* 2: Async. operation ended with error
* 3: Invalid board (bad board name, not initialised etc)


|x1= <code>[[leaderboardState]] ["TT01", 1234, [5,6,7,8]]</code>
|x1= <sqf>leaderboardState "TT01";</sqf>


|seealso= [[leaderboardsRequestUploadScoreKeepBest]] [[leaderboardsRequestUploadScore]]
|seealso= [[leaderboardsRequestUploadScoreKeepBest]] [[leaderboardsRequestUploadScore]]
}}
}}
<!-- huh?
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}
-->

Latest revision as of 12:54, 26 April 2023

Hover & click on the images for description

Description

Description:
Returns the state of the board with the given name.
Groups:
Leaderboards

Syntax

Syntax:
leaderboardState boardname
Parameters:
boardname: String
Return Value:
Number
  • 0: Busy (async. operation in progress)
  • 1: Async. operation ended with success
  • 2: Async. operation ended with error
  • 3: Invalid board (bad board name, not initialised etc)

Examples

Example 1:
leaderboardState "TT01";

Additional Information

See also:
leaderboardsRequestUploadScoreKeepBest leaderboardsRequestUploadScore

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note