Description
A person object controlled by user. In Intros and Outros this isn't set by default and must be assigned.
Syntax
player
Returns: Object
Examples
Example 1
player addRating 500;
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.
See also
Multiplayer Scripting · isPlayer · playableUnits · selectPlayer
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.
player can actually be REMOTE object on player's PC: http://www.youtube.com/watch?v=m6IILtfa3cQ