onPlayerDisconnected: Difference between revisions
Jump to navigation
Jump to search
m (Inverted _jip and _owner to reflect same order as PlayerDisconnected) |
m (idem for _name and _uid) |
||
Line 10: | Line 10: | ||
* '''_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. | * '''_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. | * '''_name''': [[String]] - is [[profileName]] of the leaving player. | ||
* '''_jip''': (''since Arma 3 v1.49'') [[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]]. | * '''_jip''': (''since Arma 3 v1.49'') [[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]]. | ||
* '''_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]]. | * '''_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]]. |
Revision as of 22:12, 22 May 2016
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.
- _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: (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.
- _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.
- Multiplayer:
- In MP onPlayerDisconnected is executed only on the server
- Groups:
- Uncategorised
Syntax
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
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.