onPlayerConnected: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "|exec=" to "|serverExec=") |
Lou Montana (talk | contribs) m (Text replacement - "\| *((\[\[[a-zA-Z0-9_ |()]+\]\],? ?)+) * \}\}" to "|seealso= $1 }}") |
||
| (21 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{ | {{RV|type=command | ||
| | | arma1 | ||
|1.00 | |1.00 | ||
| | |gr1 = Multiplayer | ||
|gr2= Event Handlers | |||
|serverExec= server | |||
| This command will execute attached code whenever a player is connected to a MP session. The code will receive a number of special variables: | | This command will execute attached code whenever a player is connected to a MP session. The code will receive a number of special variables: | ||
| Line 13: | Line 15: | ||
* '''_uid''': [[String]] - is [[getPlayerUID]] of the joining player. In Arma 3 it is also the same as Steam ID. | * '''_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. | * '''_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 ('''J'''oined '''I'''n '''P'''rogress). [[true]] when the player is [[JIP]], otherwise [[false]]. | * '''_jip''': (''since Arma 3 v1.49'') [[Boolean]] - is a flag that indicates whether or not the player joined after the mission has started ('''J'''oined '''I'''n '''P'''rogress). [[true]] when the player is [[Multiplayer Scripting#Join In Progress|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]]. | * '''_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]]. | ||
* '''_idstr''': (''since Arma 3 v1.95'') [[String]] - same as <tt>_id</tt> but in string format, so could be exactly compared to [[allMapMarkers | user marker]] ids.<br><br> | * '''_idstr''': (''since Arma 3 v1.95'') [[String]] - same as <tt>_id</tt> but in string format, so could be exactly compared to [[allMapMarkers | user marker]] ids.<br><br> | ||
{{Feature arma3 | Since '''Arma 3''' ''v1.57'' a stackable MissionEventHandler is available and should be used: [[Arma_3:_Event_Handlers/addMissionEventHandler#PlayerConnected|PlayerConnected]].<br> | {{Feature|arma3 | Since '''Arma 3''' ''v1.57'' a stackable MissionEventHandler is available and should be used: [[Arma_3:_Event_Handlers/addMissionEventHandler#PlayerConnected|PlayerConnected]].<br> | ||
Before that, the functions [[BIS_fnc_addStackedEventHandler]] and [[BIS_fnc_removeStackedEventHandler]] should be used instead in order to keep compatibility between official and community content.}} | Before that, the functions [[BIS_fnc_addStackedEventHandler]] and [[BIS_fnc_removeStackedEventHandler]] should be used instead in order to keep compatibility between official and community content.}} | ||
| [[onPlayerConnected]] code | | [[onPlayerConnected]] code | ||
|p1= code: [[String]] or [[Code]] | |p1= code: [[String]] or [[Code]] | ||
| [[Nothing]] | | [[Nothing]] | ||
|x1= <code>[[onPlayerConnected]] "[_id, _name] [[execVM]] ""PlayerConnected.sqf""";</code> | |x1= <code>[[onPlayerConnected]] "[_id, _name] [[execVM]] ""PlayerConnected.sqf""";</code> | ||
|x2= <code>[[onPlayerConnected]] { [[diag_log]] [_id, _uid, _name] };</code> | |x2= <code>[[onPlayerConnected]] { [[diag_log]] [_id, _uid, _name] };</code> | ||
|x3= From '''{{arma3}}''' v1.49: | |x3= From '''{{arma3}}''' v1.49: | ||
| Line 37: | Line 37: | ||
{{cc|this will set somevar}} | {{cc|this will set somevar}} | ||
{{cc|joining player PC to a random value}} | {{cc|joining player PC to a random value}} | ||
};</code> | };</code> | ||
|x4= From '''{{arma3}}''' v1.49: | |x4= From '''{{arma3}}''' v1.49: | ||
<code>[[onPlayerConnected]] { isJip = _jip; _owner [[publicVariableClient]] "isJip" }; | <code>[[onPlayerConnected]] { isJip = _jip; _owner [[publicVariableClient]] "isJip" }; | ||
{{cc|Each player will now have variable isJip containing individual JIP info}}</code> | {{cc|Each player will now have variable isJip containing individual JIP info}}</code> | ||
|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> | ||
This happens even if '''onPlayerConnected''' was issued on all machines. <br> | This happens even if '''onPlayerConnected''' was issued on all machines. <br> | ||
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]] | |seealso= [[onPlayerDisconnected]], [[didJIP]], [[didJIPOwner]] | ||
}} | }} | ||
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]] | [[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]] | ||
{{GameCategory|ofpe|Scripting Commands}} | |||
{{GameCategory|arma1|Scripting Commands}} | |||
{{GameCategory|arma2|Scripting Commands}} | |||
{{GameCategory|arma3|Scripting Commands}} | |||
{{GameCategory|tkoh|Scripting Commands}} | |||
Revision as of 00:53, 17 February 2021
Description
- Description:
- Description needed
- 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 code. - Groups:
- MultiplayerEvent Handlers
Syntax
- Syntax:
- Syntax needed
- Parameters:
- code: String or Code
- Return Value:
- Return value needed
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 // 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
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