isPlayer: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Text replacement - "[[Category:Scripting Commands ArmA|" to "[[Category:Scripting Commands Armed Assault|")
(12 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{Command|Comments=
____________________________________________________________________________________________
____________________________________________________________________________________________


| arma |= Game name
| arma |Game name=


|1.00|= Game version
|1.00|Game version=


|arg= global |= Arguments in MP
|arg= global |Multiplayer Arguments=
____________________________________________________________________________________________
____________________________________________________________________________________________


| Check if given person is a human player. |= Description
| Checks if given person is [[player]]. Returns [[true]] for headless clients as well.<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=
____________________________________________________________________________________________
____________________________________________________________________________________________


| '''isPlayer''' person |= Syntax
| '''isPlayer''' person |SYNTAX=


|p1= person: [[Object]] |= Parameter 1
|p1= person: [[Object]] |PARAMETER1=


| [[Boolean]] |= Return value
| [[Boolean]] |RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code>[[if]] ([[isPlayer]] _Soldier1) [[then]] {
|x1= <code>[[if]] ([[isPlayer]] _Soldier1) [[then]] {
     _Soldier1 [[setDamage]] 1;
     _Soldier1 [[setDamage]] 1;
};</code> |= Example 1
};</code> |EXAMPLE1=


|x2= <code>_playerCount = {[[isPlayer]] _x} [[count]] [[playableUnits]];</code> |= Example 2
|x2= <code>_playerCount = {[[isPlayer]] _x} [[count]] [[playableUnits]];</code> |EXAMPLE2=
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[player]], [[playableSlotsNumber]], [[playableUnits]], [[playersNumber]] |= See also
| [[player]], [[playableSlotsNumber]], [[playableUnits]], [[playersNumber]] |SEEALSO=


}}
}}
Line 43: Line 44:
<h3 style="display:none">Bottom Section</h3>
<h3 style="display:none">Bottom Section</h3>
[[Category:Scripting Commands|ISPLAYER]]
[[Category:Scripting Commands|ISPLAYER]]
[[Category:Scripting Commands ArmA|ISPLAYER]]
[[Category:Scripting Commands Armed Assault|ISPLAYER]]
[[Category:Command_Group:_Object_Information|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Object_Information|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Multiplayer|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Multiplayer|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[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}}}}]]
 
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on June 3, 2016 - 12:58 (UTC)</dd>
<dt class="note">[[User:Commy2|Commy2]]</dt>
<dd class="note">
This command reports true for headless client objects.
</dd>
</dl>
<!-- DISCONTINUE Notes -->

Revision as of 20:07, 3 June 2020

-wrong parameter ("Arma") defined!-1.00
GAGlobal
Hover & click on the images for description

Description

Description:
Checks if given person is player. Returns true for headless clients as well.

⚠
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.[1] Therefore, beware of false negatives.
Groups:
Uncategorised

Syntax

Syntax:
isPlayer person
Parameters:
person: Object
Return Value:
Boolean

Examples

Example 1:
if (isPlayer _Soldier1) then { _Soldier1 setDamage 1; };
Example 2:
_playerCount = {isPlayer _x} count playableUnits;

Additional Information

See also:
playerplayableSlotsNumberplayableUnitsplayersNumber

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

Posted on 1 August, 2006
Kronzky
This is not the same as testing object == player, because in MP it tests for any player, not only for the local one. If object is a vehicle, the test is done for the vehicle commander.

Bottom Section

  1. ↑ https://github.com/michail-nikolaev/task-force-arma-3-radio/issues/1096
Retrieved from "https://community.bistudio.com/wiki?title=isPlayer&oldid=152996"