onPlayerConnected

1.00

Hover & click on the images for descriptions

Description

Description:

This command will execute attached code whenever a player is connected to a MP session. The code will receive a number of special variables:

• _id: Number - is the unique DirectPlay ID. Quite useless as the number is too big for in-built string representation and gets rounded. It is also the same id used for user placed markers.
• _uid: String - is getPlayerUID of the joining player. In Arma 3 it is also the same as Steam ID.
• _name: String - is profileName of the joining player.
• _jip: (since Arma 3 v1.49) Boolean - is a flag that indicates whether or not the player joined after the mission has started (Joined In Progress). true when the player is JIP, otherwise false.
• _owner: (since Arma 3 v1.49) Number - is owner id of the joining player. Can be used for kick or ban purposes or just for publicVariableClient.
• _idstr: (since Arma 3 v1.95) String - same as _id but in string format, so could be exactly compared to user marker ids.
  
  

Since Arma 3 v1.57 a stackable MissionEventHandler is available and should be used: PlayerConnected.
Before that, the functions BIS_fnc_addStackedEventHandler and BIS_fnc_removeStackedEventHandler should be used instead in order to keep compatibility between official and community content.

Multiplayer:

The statement is executed only on the server, not on the joining player's computer, nor on any other client.
This happens even if onPlayerConnected was issued on all machines.
Note that there is a player with the _name called __SERVER__ which will also connect to a multiplayer game, executing code.

Syntax

Syntax:

onPlayerConnected code

Parameters:

code: String or Code

Return Value:

Nothing

Examples

Example 1:

onPlayerConnected "[_id, _name] execVM ""PlayerConnected.sqf""";

Example 2:

onPlayerConnected { diag_log [_id, _uid, _name] };

Example 3:

From Arma 3 v1.49: onPlayerConnected { somevar = random 123; _owner publicVariableClient "somevar"; // this will set somevar // joining player PC to a random value };

Example 4:

From Arma 3 v1.49: onPlayerConnected { isJip = _jip; _owner publicVariableClient "isJip" }; // Each player will now have variable isJip containing individual JIP info

Additional Information

See also:

onPlayerDisconnecteddidJIPdidJIPOwner

Groups:

MultiplayerEvent Handlers

Notes

i

Only post proven facts here. Report bugs on the Feedback Tracker and discuss on the Arma Discord or on the Forums.

+ Add Note (Help)