onPlayerDisconnected: Difference between revisions
Jump to navigation
Jump to search
(formatting) |
m (margin to since template) |
||
Line 42: | Line 42: | ||
* _name: [[String]] - Is [[profileName]] of the leaving player. | * _name: [[String]] - Is [[profileName]] of the leaving player. | ||
* _jip: [[Boolean]] - Is a flag that indicated whether or not the player joined after the mission has started ('''J'''oined '''I'''n '''P'''rogress). [[true]] - if the player was JIP, otherwise [[false]]. {{Since|arma3|1.50}} | * _jip: [[Boolean]] - Is a flag that indicated whether or not the player joined after the mission has started ('''J'''oined '''I'''n '''P'''rogress). [[true]] - if the player was JIP, otherwise [[false]]. {{Since|arma3|1.50|y}} | ||
* _owner: [[Number]] - Is [[owner]] id of the leaving player. Can be used for kick or ban purposes or just for [[publicVariableClient]]. {{Since|arma3|1.50}} | * _owner: [[Number]] - Is [[owner]] id of the leaving player. Can be used for kick or ban purposes or just for [[publicVariableClient]]. {{Since|arma3|1.50|y}} | ||
* _idstr: [[String]] - Same as <tt>_id</tt> but in string format, so could be exactly compared to [[allMapMarkers | user marker]] ids. {{Since|arma3|1.96}} | * _idstr: [[String]] - Same as <tt>_id</tt> but in string format, so could be exactly compared to [[allMapMarkers | user marker]] ids. {{Since|arma3|1.96|y}} | ||
|r1= [[Nothing]] | |r1= [[Nothing]] |
Revision as of 19:25, 26 March 2021
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:
- Multiplayer:
- In multiplayer onPlayerDisconnected is executed only on the server.
- Groups:
- MultiplayerEvent Handlers
Syntax
- Syntax:
- onPlayerDisconnected code
- Parameters:
- code: String or Code - Code executed. 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 leaving player. In Arma 3 it is also the same as Steam ID.
- _name: String - Is profileName of the leaving player.
- _jip: 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. Template:Since
- _owner: Number - Is owner id of the leaving player. Can be used for kick or ban purposes or just for publicVariableClient. Template:Since
- _idstr: String - Same as _id but in string format, so could be exactly compared to user marker ids. Template:Since
- Return Value:
- Nothing
Examples
- Example 1:
onPlayerDisconnected {diag_log [_id, _uid, _name]};
- Example 2:
onPlayerDisconnected { if (count allPlayers == 0) then { endMission "END1"; }; };
Additional Information
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
Categories:
- Scripting Commands
- Introduced with Armed Assault version 1.00
- ArmA: Armed Assault: New Scripting Commands
- ArmA: Armed Assault: Scripting Commands
- Arma 2: Scripting Commands
- Arma 2: Operation Arrowhead: Scripting Commands
- Take On Helicopters: Scripting Commands
- Arma 3: Scripting Commands
- Command Group: Multiplayer
- Command Group: Event Handlers
- Scripting Commands: Server Execution