leaderboardState: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\| (\[\[[a-zA-Z0-9 _]+\]\][^ ]*) \}\}" to "|seealso= ‎$1 }}")
m (Some wiki formatting)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| arma3
|game1= arma3
 
|version1= 1.42
|1.42


|gr1= Leaderboards
|gr1= Leaderboards


| 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 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
|s1= [[leaderboardState]] boardname


|p1= boardname: [[String]] -
|p1= boardname: [[String]] -
Line 17: Line 16:
|x1= <code>[[leaderboardState]] ["TT01", 1234, [5,6,7,8]]</code>
|x1= <code>[[leaderboardState]] ["TT01", 1234, [5,6,7,8]]</code>


|seealso= ‎[[leaderboardsRequestUploadScoreKeepBest]] leaderboardsRequestUploadScore
|seealso= ‎[[leaderboardsRequestUploadScoreKeepBest]] [[leaderboardsRequestUploadScore]]
}}
}}


<!-- huh?
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}
-->

Revision as of 02:53, 13 June 2021

Hover & click on the images for description

Description

Description:
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.).
Groups:
Leaderboards

Syntax

Syntax:
leaderboardState boardname
Parameters:
boardname: String -
Return Value:
Number

Examples

Example 1:
leaderboardState ["TT01", 1234, [5,6,7,8]]

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