player: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (+ Note about intros and outros)
m (Fix page and add Multiplayer Scripting link)
(29 intermediate revisions by 14 users not shown)
Line 1: Line 1:
[[Category:Scripting Commands|PLAYER]]
{{Command|Comments=
[[Category:Scripting Commands OFP 1.96|PLAYER]]
____________________________________________________________________________________________
[[Category:Scripting Commands OFP 1.46|PLAYER]]
[[Category:Scripting Commands ArmA|PLAYER]]


| ofp |Game name=


<h2 style="color:#000066">'''player'''</h2>
|1.00|Game version=
____________________________________________________________________________________________


| A person object controlled by user. In Intros and Outros this isn't set by default and must be assigned.<br /><br />
In MP [[player]] is different on each computer and on dedicated server it is [[objNull]]. When user is joining dedicated server, at the moment of [[onPlayerConnected]] the [[player]] object is remote to the joining client, as the [[player]] unit is created on the server, but once control of the unit is passed to the user moments later, the [[player]] objects becomes [[local]] to the client and stays local.<br /><br />


'''Operand types:'''
See [[Multiplayer Scripting#General information about locality|Multiplayer Scripting's player topic]] for additional helpful information. |Description=
____________________________________________________________________________________________


None
| [[player]] |Syntax=


'''Type of returned value:'''
| [[Object]] |Return value=
____________________________________________________________________________________________
 
|x1= <code>[[player]] [[addRating]] 500;</code> |Example 1=
____________________________________________________________________________________________


[[Object]]
|pr= In MP the command is not initialised in functions called by initline or init eventhandlers.|=


'''Description:'''
| [[Multiplayer Scripting]], [[isPlayer]], [[playableUnits]], [[selectPlayer]]  |See also=
}}


Person controled by player.
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<dd class="notedate">Posted on 20 Jul, 2010
<dt class="note">[[User:GalZohar|GalZohar]]
<dd class="note">Before you use the '''player''' object (usually to avoid JIP issues) all you need is to run:<br>
<code>[[waitUntil]] { [[not]] [[isNull]] [[player]] };</code>
Anything else you see in other scripts is equivalent and/or redundant.
Of course JIP players may need more than just the player to point at the actual JIP player unit, but that's script/mission-specific.


In MP this value is different on each computer.
<dd class="notedate">Posted on 27 Jan, 2008
<dt class="note">[[User:Dr_Eyeball|Dr_Eyeball]]
<dd class="note"><code>[[isNull]] [[player]]</code> is true for JIP players on their client during initialization.<br />
After initialization, it will be set, making it valid again.<br /><br />
To cater for this, some people use code similar to the following in their <u>spawned</u> scripts:
<code>if (![[isServer]] && (player != player)) then
{
[[waitUntil]] { player == player };
[[waitUntil]] { time > 10 };
};


{{codecomment|// 'player' will now be valid}}
_action = [[player]] [[addAction]] ["heal", "heal.sqf", [], -1, false, false, ""];
</code>


'''Example:'''
<dd class="notedate">Posted on June 26, 2014 - 18:49 (UTC)
<dt class="note">[[User:Killzone Kid|Killzone Kid]]
<dd class="note">[[player]] can actually be REMOTE object on player's PC: http://www.youtube.com/watch?v=m6IILtfa3cQ<br><br>
</dd>


'''player''' addrating 500
<!-- Note Section END -->
</dl>


 
<h3 style="display:none">Bottom Section</h3>
'''MP Note:'''
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands OFP 1.46|{{uc:{{PAGENAME}}}}]]
The variable '''player''' is not always initialised at startup of a mission, you have to add a (very short) delay before you can use it.
[[Category:Scripting Commands OFP 1.96|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
'''Intro/Outro:'''
[[Category:Scripting Commands ArmA|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
The variable '''player''' is not defined at all, but you can give name '''player''' to unit which is marked as player.
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]

Revision as of 02:34, 29 January 2019

Logo A0.png1.00
Hover & click on the images for description

Description

Description:
A person object controlled by user. In Intros and Outros this isn't set by default and must be assigned.

In MP player is different on each computer and on dedicated server it is objNull. When user is joining dedicated server, at the moment of onPlayerConnected the player object is remote to the joining client, as the player unit is created on the server, but once control of the unit is passed to the user moments later, the player objects becomes local to the client and stays local.

See Multiplayer Scripting's player topic for additional helpful information.
Problems:
In MP the command is not initialised in functions called by initline or init eventhandlers.
Groups:
Uncategorised

Syntax

Syntax:
player
Return Value:
Object

Examples

Example 1:
player addRating 500;

Additional Information

See also:
Multiplayer ScriptingisPlayerplayableUnitsselectPlayer

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 20 Jul, 2010
GalZohar
Before you use the player object (usually to avoid JIP issues) all you need is to run:
waitUntil { not isNull player }; Anything else you see in other scripts is equivalent and/or redundant. Of course JIP players may need more than just the player to point at the actual JIP player unit, but that's script/mission-specific.
Posted on 27 Jan, 2008
Dr_Eyeball
isNull player is true for JIP players on their client during initialization.
After initialization, it will be set, making it valid again.

To cater for this, some people use code similar to the following in their spawned scripts: if (!isServer && (player != player)) then { waitUntil { player == player }; waitUntil { time > 10 }; }; // 'player' will now be valid _action = player addAction ["heal", "heal.sqf", [], -1, false, false, ""];
Posted on June 26, 2014 - 18:49 (UTC)
Killzone Kid
player can actually be REMOTE object on player's PC: http://www.youtube.com/watch?v=m6IILtfa3cQ

Bottom Section

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