Difference between revisions of "onPlayerConnected"
Jump to navigation
Jump to search
killzone_kid (talk | contribs) m |
m (template:command argument fix) |
||
Line 17: | Line 17: | ||
{{Informative|Since '''Arma 3''' ''v1.57'' a stackable version of this EH is available: [[Arma_3:_Event_Handlers/addMissionEventHandler#PlayerConnected|PlayerConnected]]}}<br> | {{Informative|Since '''Arma 3''' ''v1.57'' a stackable version of this EH is available: [[Arma_3:_Event_Handlers/addMissionEventHandler#PlayerConnected|PlayerConnected]]}}<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= |
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
− | | '''onPlayerConnected''' code |= | + | | '''onPlayerConnected''' code |SYNTAX= |
− | |p1= code: [[String]] or [[Code]] |= | + | |p1= code: [[String]] or [[Code]] |PARAMETER1= |
− | | [[Nothing]] |= | + | | [[Nothing]] |RETURNVALUE= |
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
− | |x1= <code>[[onPlayerConnected]] "[_id, _name] [[execVM]] ""PlayerConnected.sqf""";</code> |= | + | |x1= <code>[[onPlayerConnected]] "[_id, _name] [[execVM]] ""PlayerConnected.sqf""";</code> |EXAMPLE1= |
− | |x2= <code>[[onPlayerConnected]] {[[diag_log]] [_id, _uid, _name]};</code> |= | + | |x2= <code>[[onPlayerConnected]] {[[diag_log]] [_id, _uid, _name]};</code> |EXAMPLE2= |
|x3= From Arma 3 v1.49: <code>[[onPlayerConnected]] { | |x3= From Arma 3 v1.49: <code>[[onPlayerConnected]] { | ||
somevar = [[random]] 123; | somevar = [[random]] 123; | ||
Line 34: | Line 34: | ||
//this will set somevar on | //this will set somevar on | ||
//joining player PC to a random value | //joining player PC to a random value | ||
− | };</code>|= | + | };</code>|EXAMPLE2= |
|x4= From Arma 3 v1.49: <code>[[onPlayerConnected]] {isJip = _jip; _owner [[publicVariableClient]] "isJip"}; | |x4= From Arma 3 v1.49: <code>[[onPlayerConnected]] {isJip = _jip; _owner [[publicVariableClient]] "isJip"}; | ||
− | //Each player will now have variable isJip containing individual JIP info</code>|= | + | //Each player will now have variable isJip containing individual JIP info</code>|EXAMPLE2= |
|mp= The ''statement'' is executed only on the server, not on the joining player's computer, nor on any other client.<br> | |mp= The ''statement'' is executed only on the server, not on the joining player's computer, nor on any other client.<br> | ||
Line 43: | Line 43: | ||
Note that there is a player with the '''_name''' called __SERVER__ which will also connect to a multiplayer game, executing ''code''. |= | Note that there is a player with the '''_name''' called __SERVER__ which will also connect to a multiplayer game, executing ''code''. |= | ||
− | | [[onPlayerDisconnected]], [[didJIP]], [[didJIPOwner]]|= | + | | [[onPlayerDisconnected]], [[didJIP]], [[didJIPOwner]]|SEEALSO= |
}} | }} |
Revision as of 14:44, 7 April 2019
Hover & click on the images for descriptions
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.
- _uid: String - is getPlayerUID of the joining player. In Arma 3 it is also the same as Steam ID.
- _name: String - is profileName of the joining player.
- _jip: (since Arma 3 v1.49) Boolean - is a flag that indicates whether or not the player joined after the mission has started (Joined In Progress). true - when the player is JIP, otherwise false.
- _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.
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 code.
Syntax
Examples
- Example 1:
-
onPlayerConnected "[_id, _name] execVM ""PlayerConnected.sqf""";
- Example 2:
-
onPlayerConnected {diag_log [_id, _uid, _name]};
- Example 3:
- From Arma 3 v1.49:
onPlayerConnected { somevar = random 123; _owner publicVariableClient "somevar"; //this will set somevar on //joining player PC to a random value };
- Example 4:
- From Arma 3 v1.49:
onPlayerConnected {isJip = _jip; _owner publicVariableClient "isJip"}; //Each player will now have variable isJip containing individual JIP info
Additional Information
- See also:
- onPlayerDisconnecteddidJIPdidJIPOwner
- Groups:
- Uncategorised
Notes
Notes
Bottom Section
Categories:
- Pages using duplicate arguments in template calls
- Scripting Commands
- Arma: Scripting Commands
- Arma: New Scripting Commands
- Command Group: Uncategorised
- Pages with broken file links
- Introduced with Arma version 1.00
- Scripting Commands OFP Elite
- Scripting Commands ArmA
- Scripting Commands ArmA2
- Scripting Commands Arma 3
- Scripting Commands Take On Helicopters
- Command Group: Multiplayer