leaderboardGetRows: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Arma[ _]3(\|.*)\]\]" to "{{GameCategory|arma3|Scripting Commands}}")
m (Text replacement - " +\]" to "]")
 
(33 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


|arma3|Game name=
|game1= arma3
|version1= 1.56


|1.56|Game version=
|gr1= Leaderboards


|gr1 = LeaderBoards |GROUP1=
|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!


|arg=  |Multiplayer Arguments=
|s1= [[leaderboardGetRows]] boardName


|eff= |Multiplayer Effects=
|p1= boardName: [[String]]
____________________________________________________________________________________________


| 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=
|r1= [[Array]] in format: <nowiki>[[player1Name, score, rank], [player2Name, score, rank], [player3Name, score, rank] ...]</nowiki>
____________________________________________________________________________________________


| [[leaderboardGetRows]] boardName |SYNTAX=
|x1= <sqf>leaderboardGetRows "TT01";</sqf>
 
|p1=  boardName: [[String]]|PARAMETER1=
 
| [[Array]] |RETURNVALUE=
 
 
____________________________________________________________________________________________
 
|x1= <code>[[leaderboardGetRows]] "TT01"</code>|EXAMPLE1=
____________________________________________________________________________________________
 
|x2=  |EXAMPLE2=
____________________________________________________________________________________________
 
|x3=  |EXAMPLE3=
____________________________________________________________________________________________
 
|x4=  |EXAMPLE4=
____________________________________________________________________________________________
 
|x5=  |EXAMPLE5=
____________________________________________________________________________________________
 
|x6=  |EXAMPLE6=
____________________________________________________________________________________________
 
|x7=  |EXAMPLE7=
____________________________________________________________________________________________
 
|x8=  |EXAMPLE8=
____________________________________________________________________________________________
 
|x9=  |EXAMPLE9=
____________________________________________________________________________________________
 
|x10=  |EXAMPLE10=
____________________________________________________________________________________________
 
| [[leaderboardDeInit]],[[leaderboardInit]],[[leaderboardRequestRowsFriends]],[[leaderboardRequestRowsGlobal]],[[leaderboardRequestRowsGlobalAroundUser]],[[leaderboardsRequestUploadScore]],[[leaderboardsRequestUploadScoreKeepBest]],[[leaderboardState]] |SEEALSO=


|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 -->
{{GameCategory|arma3|New_Scripting_Commands_List}}
{{GameCategory|arma3|Scripting Commands}}
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_LeaderBoards|{{uc:{{PAGENAME}}}}]]

Latest revision as of 19:15, 8 November 2023

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