getPlayerScores: Difference between revisions

From Bohemia Interactive Community
m (Fix note)
(Add side changing issue note)
 
(30 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
|arma3|Game name=
|1.56|Game version=


|gr1= Multiplayer |GROUP1=
|game1= arma3
|version1= 1.56


| In MP: returns the unit's table of scores (infantry kills, soft vehicle kills, armor kills, air kills, deaths, total score). In SP: empty array []  |DESCRIPTION=
|gr1= Multiplayer
|  '''getPlayerScores''' unitName |SYNTAX=
|p1= unitName: [[Object]] |PARAMETER1=
|p2=  |PARAMETER2=
| [[Array]] - the score of the given player in format [infantry kills, soft vehicle kills, armor kills, air kills, deaths, total score] |RETURNVALUE=
|x1= <code>[[getPlayerScores]] BIS_player1;</code>|EXAMPLE1=


| [[score]], [[addScore]], [[scoreSide]], [[addScoreSide]] |SEEALSO=
|descr= Returns the unit's table of scores (infantry kills, soft vehicle kills, armor kills, air kills, deaths, total score) '''in multiplayer''' or an empty array in singleplayer.
}}
{{Feature|important|This command does not work (returns empty array) if the unit's side has been changed (e.g <sqf inline>[player] joinSilent createGroup east</sqf>).}}


|s1= [[getPlayerScores]] unitName


<h3 style='display:none'>Bottom Section</h3>
|p1= unitName: [[Object]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]


<h3 style='display:none'>Notes</h3>
|r1= [[Array]] of [[Number]]s - the score of the given player in format [infantry kills, soft vehicle kills, armor kills, air kills, deaths, total score]
<dl class="command_description">
<!-- BEGIN Note Section -->
<!-- END Note Section -->
</dl>


<h3 style="display:none">Bottom Section</h3>
|x1= <sqf>
[[Category:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]
getPlayerScores BIS_player1; // e.g [4, 0, 3, 1, 2, 16]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
// or in SP: []
</sqf>


<!-- CONTINUE Notes -->
|seealso= [[score]] [[addScore]] [[scoreSide]] [[addScoreSide]] [[addPlayerScores]]
<dl class="command_description">
}}
<dd class="notedate">Posted on November 18, 2020 - 14:14 (UTC)</dd>
<dt class="note">[[User:Tankbuster|Tankbuster]]</dt>
<dd class="note">
There is a setter for this: [[addPlayerScores]]
</dd>
</dl>
<!-- DISCONTINUE Notes -->

Latest revision as of 13:09, 26 February 2025

Hover & click on the images for description

Description

Description:
Returns the unit's table of scores (infantry kills, soft vehicle kills, armor kills, air kills, deaths, total score) in multiplayer or an empty array in singleplayer.
This command does not work (returns empty array) if the unit's side has been changed (e.g [player] joinSilent createGroup east).
Groups:
Multiplayer

Syntax

Syntax:
getPlayerScores unitName
Parameters:
unitName: Object
Return Value:
Array of Numbers - the score of the given player in format [infantry kills, soft vehicle kills, armor kills, air kills, deaths, total score]

Examples

Example 1:
getPlayerScores BIS_player1; // e.g [4, 0, 3, 1, 2, 16] // or in SP: []

Additional Information

See also:
score addScore scoreSide addScoreSide addPlayerScores

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