leaderboardState: Difference between revisions

Latest revision as of 12:54, 26 April 2023

Hover & click on the images for description

Syntax:

leaderboardState boardname

Parameters:

boardname: String

Return Value:

Number

See also:: leaderboardsRequestUploadScoreKeepBest leaderboardsRequestUploadScore

: 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

@@ Line 1: / Line 1: @@
-{{Command
+{{RV|type=command
-| arma3
+|game1= arma3
+|version1= 1.42
-|1.42
+|gr1= Leaderboards
-|gr1= LeaderBoards
+|descr= Returns the state of the board with the given name.
-| 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.).
+|s1= [[leaderboardState]] boardname
-| '''leaderboardState''' boardname
+|p1= boardname: [[String]]
-|p1= boardname: [[String]] -
+|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)
-| [[Number]]
+|x1= <sqf>leaderboardState "TT01";</sqf>
-|x1= <code>[[leaderboardState]] ["TT01", 1234, [5,6,7,8]]</code>
+|seealso= [[leaderboardsRequestUploadScoreKeepBest]] [[leaderboardsRequestUploadScore]]
-| [[leaderboardsRequestUploadScoreKeepBest]] leaderboardsRequestUploadScore
 }}
-{{GameCategory|arma2|Scripting Commands}}
-{{GameCategory|arma3|Scripting Commands}}
-{{GameCategory|tkoh|Scripting Commands}}
-[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]