leaderboardGetRows: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Created page with "{{Command|= ____________________________________________________________________________________________ | arma3dev |= Game |1.43|= Game Version (number surrounded by NO SPA...")
 
m (Text replacement - " +\]" to "]")
 
(48 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{Command|=
{{RV|type=command
____________________________________________________________________________________________


| arma3dev |= Game
|game1= arma3
|version1= 1.56


|1.43|= Game Version (number surrounded by NO SPACES)
|gr1= Leaderboards


|arg= |= Multiplayer Arguments
|descr= Returns values for the given leaderboard; this can be called after the one of the row request function has been called and successfully finished!


|eff= |= Multiplayer Effects
|s1= [[leaderboardGetRows]] boardName
____________________________________________________________________________________________


| Returns an array with values for the given leaderboard, the array is in format: <nowiki>[[player1Name, score, rank], [player2Name, score, rank], [player3Name, score, rank] ... ]</nowiki>; This can be called after the one of the row request function has been called and successfully finished! |= Description
|p1= boardName: [[String]]
____________________________________________________________________________________________


| [[leaderboardGetRows]] boardName |= Syntax
|r1= [[Array]] in format: <nowiki>[[player1Name, score, rank], [player2Name, score, rank], [player3Name, score, rank] ...]</nowiki>


|p1=  boardName - [[String]]|= Parameter 1
|x1= <sqf>leaderboardGetRows "TT01";</sqf>
 
| [[Array]] |= Return Value
 
 
____________________________________________________________________________________________
 
|x1= <code>[[leaderboardGetRows]] "TT01"</code>|= Example 1
____________________________________________________________________________________________
 
|x2=  |= Example 2
____________________________________________________________________________________________
 
|x3=  |= Example 3
____________________________________________________________________________________________
 
|x4=  |= Example 4
____________________________________________________________________________________________
 
|x5=  |= Example 5
____________________________________________________________________________________________
 
|x6=  |= Example 6
____________________________________________________________________________________________
 
|x7=  |= Example 7
____________________________________________________________________________________________
 
|x8=  |= Example 8
____________________________________________________________________________________________
 
|x9=  |= Example 9
____________________________________________________________________________________________
 
|x10=  |= Example 10
____________________________________________________________________________________________
 
|mp= - |= Multiplayer Behaviour
 
| [[leaderboardDeInit]],[[leaderboardInit]],[[leaderboardRequestRowsFriends]],[[leaderboardRequestRowsGlobal]],[[leaderboardRequestRowsGlobalAroundUser]],[[leaderboardsRequestUploadScore]],[[leaderboardsRequestUploadScoreKeepBest]],[[leaderboardState]] |= See Also


|seealso= [[leaderboardDeInit]] [[leaderboardInit]] [[leaderboardRequestRowsFriends]] [[leaderboardRequestRowsGlobal]] [[leaderboardRequestRowsGlobalAroundUser]] [[leaderboardsRequestUploadScore]] [[leaderboardsRequestUploadScoreKeepBest]] [[leaderboardState]]
}}
}}
<dl class="command_description">
<!-- BEGIN Note Section -->
<!-- For example:
<dd class="notedate">Posted on Month Day, Year - Time (UTC)</dd>
<dt class="note">'''[[User:User Name|User Name]]'''</dt>
<dd class="note">This is an example note. It is true and verifiable, and contains a little code snippet.
<code>[[if]] ([[_this]] == anExample) [[then]] { [[hint]] "Leave it here for others to read"; };</code></dd>
-->
<!-- END Note Section -->
</dl>
<h3 style="display:none">Bottom Section</h3>
<!-- Appropriate categories go here -->
[[Category:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 19:15, 8 November 2023

Hover & click on the images for description

Description

Description:
Returns values for the given leaderboard; this can be called after the one of the row request function has been called and successfully finished!
Groups:
Leaderboards

Syntax

Syntax:
leaderboardGetRows boardName
Parameters:
boardName: String
Return Value:
Array in format: [[player1Name, score, rank], [player2Name, score, rank], [player3Name, score, rank] ...]

Examples

Example 1:
leaderboardGetRows "TT01";

Additional Information

See also:
leaderboardDeInit leaderboardInit leaderboardRequestRowsFriends leaderboardRequestRowsGlobal leaderboardRequestRowsGlobalAroundUser leaderboardsRequestUploadScore leaderboardsRequestUploadScoreKeepBest leaderboardState

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