isPlayer: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\|x([0-9])= *<code>([^<]*)<\/code>" to "|x$1= <sqf>$2</sqf>")
m (Some wiki formatting)
Line 20: Line 20:
|arg= global
|arg= global


|descr= Checks if given person is a [[player]]. Returns [[true]] for headless clients as well.<br>
|descr= Checks if given person is a [[player]]. Returns [[true]] for headless clients as well.
While identity still exists on the dead body of a player, the alternative syntax will return [[true]].


{{Feature | Informative | Prior to [[Arma 3]] v2.02, in some cases the identity of certain player units could fail to propagate to other clients and the server, which caused [[isPlayer]] and [[getPlayerUID]] to incorrectly return {{hl|[[false]]}} and {{hl|""}} respectively, where the affected units were [[not]] [[local]]. See [https://github.com/michail-nikolaev/task-force-arma-3-radio/issues/1096 this bug report (GitHub)] for more info. This was supposedly fixed, but you should remain vigilant toward false negatives nonetheless. }}
{{Feature|informative|Prior to {{arma3}} v2.02, in some cases the identity of certain player units could fail to propagate to other clients and the server, which caused [[isPlayer]] and [[getPlayerUID]] to incorrectly return {{hl|[[false]]}} and {{hl|""}} respectively, where the affected units were [[not]] [[local]]. See {{Link|https://github.com/michail-nikolaev/task-force-arma-3-radio/issues/1096|this GitHub bug report}} for more info. Remain vigilant toward potential false negatives.}}


|s1= [[isPlayer]] unit
|s1= [[isPlayer]] unit


|p1= unit: [[Object]]
|p1= unit: [[Object]]
Line 35: Line 34:
|s2since= arma3 2.06
|s2since= arma3 2.06


|p21= [person]: [[Array]]
|p21= person: [[Object]] - dead or alive unit


|p22= person: [[Object]] - dead or alive player
|r2= [[Boolean]] - [[true]] if is/was player '''and''' the identity still exists on the (dead) body


|r2= [[Boolean]] - [[true]] if is/was player
|x1= <sqf>
 
if (isPlayer _Soldier1) then
|x1= <sqf>if (isPlayer _Soldier1) then
{
{
_soldier1 setDamage 1;
_soldier1 setDamage 1;
};</sqf>
};
</sqf>


|x2= <sqf>_playerCount = { isPlayer _x } count playableUnits;</sqf>
|x2= <sqf>_playerCount = { isPlayer _x } count playableUnits;</sqf>

Revision as of 22:38, 4 September 2022

Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
GAGlobal
Hover & click on the images for description

Description

Description:
Checks if given person is a player. Returns true for headless clients as well.
ⓘ
Prior to Arma 3 v2.02, in some cases the identity of certain player units could fail to propagate to other clients and the server, which caused isPlayer and getPlayerUID to incorrectly return false and "" respectively, where the affected units were not local. See this GitHub bug report for more info. Remain vigilant toward potential false negatives.
Groups:
Multiplayer

Syntax

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

Alternative Syntax

Syntax:
isPlayer [person]
Parameters:
person: Object - dead or alive unit
Return Value:
Boolean - true if is/was player and the identity still exists on the (dead) body

Examples

Example 1:
if (isPlayer _Soldier1) then { _soldier1 setDamage 1; };
Example 2:
_playerCount = { isPlayer _x } count playableUnits;
Example 3:
private _wasPlayer = isPlayer [_deadBody]; // returns true if _deadBody's identity still exists and was controlled by a player

Additional Information

See also:
player playableSlotsNumber playableUnits playersNumber

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
Kronzky - c
Posted on Aug 01, 2006 - 00:00 (UTC)
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.
Retrieved from "https://community.bistudio.com/wiki?title=isPlayer&oldid=330373"