onPlayerDisconnected

From Bohemia Interactive Community
Jump to: navigation, search
Introduced with Armed Assault version 1.00
  This scripting command must be executed on the server to work properly in multiplayer

Click on the images for descriptions

Introduced in

Game:
Armed Assault
Version:
1.00

Description

Description:
This command will execute attached code whenever a player is leaving an 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.
  • _name: String - is profileName of the leaving player.
  • _uid: String - is getPlayerUID of the leaving player. In Arma 3 it is also the same as Steam ID.
  • _owner: (since Arma 3 v1.49) Number - is owner id of the leaving player. Can be used for kick or ban purposes or just for publicVariableClient.
  • _jip: (since Arma 3 v1.49) Boolean - is a flag that indicated whether or not the player joined after the mission has started (Joined In Progress). true - if the player was JIP, otherwise false.
Arma 3 logo black.png In order to keep compatability between official and community content the functions BIS_fnc_addStackedEventHandler and BIS_fnc_removeStackedEventHandler should be used instead.

Syntax

Syntax:
onPlayerDisconnected code
Parameters:
code: String or Code
Return Value:
Nothing

Examples

Example 1:
onPlayerDisconnected "diag_log [_id, _uid, _name]";
Example 2:
onPlayerDisconnected { if (count allPlayers == 0) then { endMission "END1"; }; };

Additional Information

Multiplayer:
In MP onPlayerDisconnected is executed only on the server
See also:
onPlayerConnectedHandleDisconnect

Notes

Only post proven facts here. Report bugs on the feedback tracker. Use the talk page or the forums for discussions.
Add New Note | How To


Notes

Bottom Section

Posted on January 14, 2015 - 19:21 (UTC)
AgentRevolution
For Arma 3 v1.32 and onward, one might want to consider using instead the HandleDisconnect mission event handler for greater flexibility.