onPlayerConnected: Difference between revisions
Jump to navigation
Jump to search
Killzone Kid (talk | contribs) (format) |
Killzone Kid (talk | contribs) (revised, tidied, new vars on dev) |
||
| Line 8: | Line 8: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| This | | 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. | |||
* '''_name''': [[String]] - is [[profileName]] of the joining player. | |||
* '''_uid''': [[String]] - is [[getPlayerUID]] of the joining player. In Arma 3 it is also the same as Steam ID. | |||
''' | * '''_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]]. | ||
* '''_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]] - when the player is JIP, otherwise [[false]]. | |||
{{Feature arma3|In order to keep compatability between official and community content the functions [[BIS_fnc_addStackedEventHandler]] and [[BIS_fnc_removeStackedEventHandler]] should be used instead.}} | {{Feature arma3|In order to keep compatability between official and community content the functions [[BIS_fnc_addStackedEventHandler]] and [[BIS_fnc_removeStackedEventHandler]] should be used instead.}} | ||
|= Description | |= Description | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| '''onPlayerConnected''' | | '''onPlayerConnected''' code |= Syntax | ||
|p1= | |p1= code: [[String]] or [[Code]] |= Parameter 1 | ||
| [[Nothing]] |= Return value | | [[Nothing]] |= Return value | ||
Revision as of 21:19, 7 July 2015
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.
- _name: String - is profileName of the joining player.
- _uid: String - is getPlayerUID of the joining player. In Arma 3 it is also the same as Steam ID.
- _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.
- _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 - when the player is JIP, otherwise false.
- 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 statement. - Groups:
- Uncategorised
Syntax
Examples
- Example 1:
onPlayerConnected "[_id, _name] execVM ""PlayerConnected.sqf""";- Example 2:
onPlayerConnected {diag_log [_id, _uid, _name]};
Additional Information
- See also:
- onPlayerDisconnected
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