getPlayerUID: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "[[Category:Scripting_Commands_Take_On_Helicopters" to "[[Category:Scripting Commands Take On Helicopters")
(Some wiki formatting)
Line 9: Line 9:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Return an uniqueID of the given unit as string if it's player and empty value if it's AI. The unique ID may be up to 100 characters long and may contain numbers, uppercase letters and underscores (the value can be used to construct a valid variable name by appending to another valid variable name).
| Return a UniqueID of the given unit (player).
<br><br>
Note: while for [[{{arma2}}]] or [[{{arma2oa}}]] until version 1.60 the result always contains a number, it should be always handled as an opaque string. Converting it to a [[Number]] can cause precision problems, as Number cannot accurately represent integers above 16777216 (2^24). Moreover, game versions since [[{{arma2oa}}]] 1.61 provide a non-numeric value as a result.<br>
<br>
{{warning | In some cases, the identity of certain player units might fail to propagate to other clients and the server, which causes [[isPlayer]] and [[getPlayerUID]] to incorrectly return <tt>[[false]]</tt> and <tt>""</tt>, respectively, where the affected units are [[not]] [[local]].<ref>https://github.com/michail-nikolaev/task-force-arma-3-radio/issues/1096</ref> Therefore, beware of false negatives.}} |DESCRIPTION=
____________________________________________________________________________________________


| '''getPlayerUID''' unit |SYNTAX=
{{Important|Up until [[{{arma2oa}}]] v.60, the result always consisted of a [[str|stringified]] number (see [[getPlayerUIDOld]]), but always had to be considered and processed as a [[String]].<!--
--> Converting it to a [[Number]] could cause precision problems, as [[Number]] cannot accurately represent integers above 16777216 (2<sup>24</sup>).<!--
--> Moreover, games since [[{{arma2oa}}]] v1.61 provide a value that is not all-numeric.}}


|p1= unit: [[Object]] |PARAMETER1=  
{{Feature arma3|The returned string is the player's steamID64:
<code>[[private]] _steamProfileUrl {{=}} "http://<nowiki/>steamcommunity.com/profiles/" + ([[getPlayerUID]] [[player]]);</code>}} |DESCRIPTION=


|p2= |PARAMETER2=  
|pr= In some cases, the identity of certain player units might fail to propagate to other clients and the server,
which causes [[isPlayer]] and [[getPlayerUID]] to incorrectly return <tt>[[false]]</tt> and <tt>""</tt> respectively,
where the affected units are [[not]] [[local]] - see [https://github.com/michail-nikolaev/task-force-arma-3-radio/issues/1096 this bug report (GitHub)].
Therefore, beware of false negatives. |PROBLEMS=
____________________________________________________________________________________________


|p3= |PARAMETER3=  
| [[getPlayerUID]] unit |SYNTAX=


| [[String]] ("_SP_AI_", "_SP_PLAYER_" in SP, "" or UID number string in MP)
|p1= unit: [[Object]] |PARAMETER1=
|RETURNVALUE=  


|x1= <code>_uid <nowiki>=</nowiki> '''getPlayerUID''' [[player]];</code> |EXAMPLE1=
| [[String]] "_SP_AI_" or "_SP_PLAYER_" in SP, "" or UID in MP.<br>
The unique ID may be up to 100 characters long and may contain numbers, uppercase letters and underscores.<br>
The value can be used to construct a valid variable name by appending to another valid variable name,<br>
e.g {{Inline code|[[missionNamespace]] [[setVariable]] ["TAG_player" + _uid, _unit];}} |RETURNVALUE=


|x1= <code>[[private]] _uid = [[getPlayerUID]] [[player]];</code> |EXAMPLE1=
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[getPlayerUIDOld]], [[getClientState]], [[getClientStateNumber]] |SEEALSO=  
| [[BIS_fnc_getUnitByUID]], [[getPlayerUIDOld]], [[getClientState]], [[getClientStateNumber]] |SEEALSO=  
 
|mp=  |MPBEHAVIOUR=
____________________________________________________________________________________________
}}
}}


Line 40: Line 42:
<dl class='command_description'>
<dl class='command_description'>
<!-- Note Section BEGIN -->
<!-- Note Section BEGIN -->
<dd class="notedate">Posted on April 17, 2014 - 22:29
 
<dt class="note">'''[[User:Master85|Master85]] ([[User talk:Master85|talk]])'''<dd class="note">In Arma 3 the returned string is the steamID64 of the player. <code> _steamProfileUrl <nowiki>= "http://steamcommunity.com/profiles/"</nowiki> + ([[getPlayerUID]] [[player]]);</code>
<!-- Note Section END -->
<!-- Note Section END -->
</dl>
</dl>
Line 47: Line 48:
<h3 style='display:none'>Bottom Section</h3>
<h3 style='display:none'>Bottom Section</h3>


[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Command Group: Multiplayer|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Multiplayer|{{uc:{{PAGENAME}}}}]]

Revision as of 20:14, 1 July 2020

Logo A2.png1.02
GAGlobal
Hover & click on the images for description

Description

Description:
Return a UniqueID of the given unit (player).
⚠
Up until Arma 2: Operation Arrowhead v.60, the result always consisted of a stringified number (see getPlayerUIDOld), but always had to be considered and processed as a String. Converting it to a Number could cause precision problems, as Number cannot accurately represent integers above 16777216 (224). Moreover, games since Arma 2: Operation Arrowhead v1.61 provide a value that is not all-numeric.
Arma 3
The returned string is the player's steamID64: private _steamProfileUrl = "http://steamcommunity.com/profiles/" + (getPlayerUID player);
Problems:
In some cases, the identity of certain player units might fail to propagate to other clients and the server, which causes isPlayer and getPlayerUID to incorrectly return false and "" respectively, where the affected units are not local - see this bug report (GitHub). Therefore, beware of false negatives.
Groups:
Uncategorised

Syntax

Syntax:
getPlayerUID unit
Parameters:
unit: Object
Return Value:
String "_SP_AI_" or "_SP_PLAYER_" in SP, "" or UID in MP.
The unique ID may be up to 100 characters long and may contain numbers, uppercase letters and underscores.
The value can be used to construct a valid variable name by appending to another valid variable name,
e.g missionNamespace setVariable ["TAG_player" + _uid, _unit];

Examples

Example 1:
private _uid = getPlayerUID player;

Additional Information

See also:
BIS_fnc_getUnitByUIDgetPlayerUIDOldgetClientStategetClientStateNumber

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

Notes

Bottom Section

Retrieved from "https://community.bistudio.com/wiki?title=getPlayerUID&oldid=154991"