onPlayerDisconnected: Difference between revisions
Jump to navigation
Jump to search
Killzone Kid (talk | contribs) mNo edit summary |
m (template:command argument fix) |
||
| Line 16: | Line 16: | ||
{{Informative|Since '''Arma 3''' ''v1.57'' a stackable version of this EH is available: [[Arma_3:_Event_Handlers/addMissionEventHandler#PlayerDisconnected|PlayerDisconnected]]}}<br> | {{Informative|Since '''Arma 3''' ''v1.57'' a stackable version of this EH is available: [[Arma_3:_Event_Handlers/addMissionEventHandler#PlayerDisconnected|PlayerDisconnected]]}}<br> | ||
{{Feature arma3|In order to keep compatibility between official and community content the functions [[BIS_fnc_addStackedEventHandler]] and [[BIS_fnc_removeStackedEventHandler]] should be used instead.}} | {{Feature arma3|In order to keep compatibility between official and community content the functions [[BIS_fnc_addStackedEventHandler]] and [[BIS_fnc_removeStackedEventHandler]] should be used instead.}} | ||
|= | |DESCRIPTION= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| '''onPlayerDisconnected''' code |= | | '''onPlayerDisconnected''' code |SYNTAX= | ||
|p1= code: [[String]] or [[Code]] |= | |p1= code: [[String]] or [[Code]] |PARAMETER1= | ||
| [[Nothing]] |= | | [[Nothing]] |RETURNVALUE= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
|x1= <code>[[onPlayerDisconnected]] "[[diag_log]] [_id, _uid, _name]";</code> |= | |x1= <code>[[onPlayerDisconnected]] "[[diag_log]] [_id, _uid, _name]";</code> |EXAMPLE1= | ||
|x2= <code>[[onPlayerDisconnected]] { | |x2= <code>[[onPlayerDisconnected]] { | ||
[[if]] ([[count]] [[allPlayers]] == 0) [[then]] { | [[if]] ([[count]] [[allPlayers]] == 0) [[then]] { | ||
[[endMission]] "END1"; | [[endMission]] "END1"; | ||
}; | }; | ||
};</code> |= | };</code> |EXAMPLE2= | ||
| [[onPlayerConnected]], [[didJIP]], [[didJIPOwner]], [[Arma_3:_Event_Handlers/addMissionEventHandler#HandleDisconnect|HandleDisconnect]] |= | | [[onPlayerConnected]], [[didJIP]], [[didJIPOwner]], [[Arma_3:_Event_Handlers/addMissionEventHandler#HandleDisconnect|HandleDisconnect]] |SEEALSO= | ||
|mp= In MP [[onPlayerDisconnected]] is executed only on the server |= | |mp= In MP [[onPlayerDisconnected]] is executed only on the server |= | ||
Revision as of 14:44, 7 April 2019
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.
In order to keep compatibility between official and community content the functions BIS_fnc_addStackedEventHandler and BIS_fnc_removeStackedEventHandler should be used instead. - 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)
- AgentRev
- For Arma 3 v1.32 and onward, one might want to consider using instead the HandleDisconnect mission event handler for greater flexibility.