player: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Fix)
 
(77 intermediate revisions by 17 users not shown)
Line 1: Line 1:
[[Category:Scripting Commands]]
{{RV|type=command
[[Category:Scripting Commands OFP 1.97]]
[[Category:Scripting Commands OFP 1.46]]
[[Category:Scripting Commands ArmA]]


back to [[Scripting_Reference#P|COMREF]]
|game1= ofp
|version1= 1.00


<h2 style="color:#000066">'''player'''</h2>
|game2= ofpe
|version2= 1.00


|game3= arma1
|version3= 1.00


'''Operand types:'''
|game4= arma2
|version4= 1.00


None
|game5= arma2oa
|version5= 1.50


'''Type of returned value:'''
|game6= tkoh
|version6= 1.00


[[Object]]
|game7= arma3
|version7= 0.50


'''Description:'''
|gr1= Object Manipulation


Person controled by player.
|descr= A person object controlled by user. In Intros and Outros this isn't set by default and must be assigned.


In MP this value is different on each computer.
|mp= In MP [[player]] is different on each computer and on dedicated server it is [[objNull]] by default ({{Link|https://www.youtube.com/watch?v{{=}}JzgJe9sXAiU|unless scripted}}).
When user is joining a dedicated server mission, 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 and remains [[Multiplayer Scripting#Locality|local]] to the client.


See [[Multiplayer Scripting#General information about locality|Multiplayer Scripting's player topic]] for additional helpful information.


'''Example:'''
|pr= In multiplayer, the command is not initialised in functions called by initline or init eventhandlers.


'''player''' addrating 500
|s1= [[player]]
 
|r1= [[Object]]
 
|x1= <sqf>player addRating 500;</sqf>
 
|seealso= [[Multiplayer Scripting]] [[isPlayer]] [[playableUnits]] [[selectPlayer]]
}}
 
{{Note
|user= Galzohar
|timestamp= 20100620031100
|text= Before you use the '''player''' object in init scripts, to avoid JIP issues all you need is to run:
<sqf>waitUntil { not isNull player };</sqf>
Anything else you see in other scripts is equivalent and/or redundant. (but you may need to add other conditions too, such as checking [[hasInterface]] before initiating that loop)<br>
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.
}}
 
{{Note
|user= Killzone_Kid
|timestamp= 20140626184900
|text= [[player]] can actually be REMOTE object on player's PC: {{Link|http://www.youtube.com/watch?v{{=}}m6IILtfa3cQ}}
}}

Latest revision as of 23:56, 24 April 2024

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.
Multiplayer:
In MP player is different on each computer and on dedicated server it is objNull by default (unless scripted). When user is joining a dedicated server mission, 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 and remains local to the client. See Multiplayer Scripting's player topic for additional helpful information.
Problems:
In multiplayer, the command is not initialised in functions called by initline or init eventhandlers.
Groups:
Object Manipulation

Syntax

Syntax:
player
Return Value:
Object

Examples

Example 1:
player addRating 500;

Additional Information

See also:
Multiplayer Scripting isPlayer playableUnits selectPlayer

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
Galzohar - c
Posted on Jun 20, 2010 - 03:11 (UTC)
Before you use the player object in init scripts, 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. (but you may need to add other conditions too, such as checking hasInterface before initiating that loop)
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.
Killzone_Kid - c
Posted on Jun 26, 2014 - 18:49 (UTC)
player can actually be REMOTE object on player's PC: [1]