leaderboardState: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|= Game name" to "|Game name=")
m (Text replacement - "‎" to "")
 
(31 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma3 |Game name=
|game1= arma3
|version1= 1.42


|1.42|= Game version
|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.). |DESCRIPTION=
|descr= Returns the state of the board with the given name.
____________________________________________________________________________________________


| '''leaderboardState''' boardname |SYNTAX=
|s1= [[leaderboardState]] boardname


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


| [[Number]] |RETURNVALUE=
|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= <sqf>leaderboardState "TT01";</sqf>


|x1= <code>[[leaderboardState]] ["TT01", 1234, [5,6,7,8]]</code>|EXAMPLE1=
|seealso= [[leaderboardsRequestUploadScoreKeepBest]] [[leaderboardsRequestUploadScore]]
 
____________________________________________________________________________________________
 
|  |SEEALSO=
 
|  |MPBEHAVIOUR=
____________________________________________________________________________________________
}}
}}
<h3 style='display:none'>Notes</h3>
<dl class='command_description'>
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style='display:none'>Bottom Section</h3>
[[Category:ArmA 2: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 11:54, 26 April 2023

Arma 3 logo black.png1.42
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
Retrieved from "https://community.bistudio.com/wiki?title=leaderboardState&oldid=339110"