selectLeader: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (VBS2 scripting category removal)
m (Some wiki formatting)
 
(57 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma |= Game name
|game1= ofpe
|version1= 1.00


|1.00|= Game version
|game2= arma1
|version2= 1.00


|arg= local |= Arguments in MP
|game3= arma2
|version3= 1.00


|eff= global |= Effects in MP
|game4= arma2oa
____________________________________________________________________________________________
|version4= 1.50


| Select a group's leader. |= Description
|game5= tkoh
____________________________________________________________________________________________
|version5= 1.00


| groupName '''selectLeader''' unitName |= Syntax
|game6= arma3
|version6= 0.50


|p1= groupName: [[Group]] |= Parameter 1
|gr1= Groups
|p2= unitName: [[Object]] |= Parameter 2


| [[Nothing]] |= Return value
|arg= local
____________________________________________________________________________________________
 
|x1= <code>[[group]] [[player]] selectLeader [[player]]</code> |= Example 1
____________________________________________________________________________________________


| [[formationLeader]], [[formLeader]], [[leader]], [[isFormationLeader]] |= See also
|eff= global


|descr= Select the group's leader. Group locality can be checked with [[local]] command and group ownership with [[groupOwner]] command.
{{Feature | important | An invalid combination can be provided to this command, e.g ''unitName'' '''not''' being part of ''group''. In that case:
* ''unitName'' will be [[leader]] of ''group'', but will not be able to command them
* if ''unitName'' is deleted or killed, [[leader]] of ''group'' will be [[objNull]] and will not automatically be reassigned.
}}
}}


<h3 style="display:none">Notes</h3>
|s1= group [[selectLeader]] unitName
<dl class="command_description">
 
<!-- Note Section BEGIN -->
|p1= group: [[Group]]
SnowSky: In Multiplayer the command has to be executed on the client which the group is actually local, otherwhise the effect would stay only for shorter then 1 second. P.S.: remember, Teamleader is not equivalent to the client on which the group is local!
 
<!-- Note Section END -->
|p2= unitName: [[Object]]
</dl>


<h3 style="display:none">Bottom Section</h3>
|r1= [[Nothing]]
[[Category:Scripting Commands|SELECTLEADER]]
 
[[Category:Scripting Commands OFP Elite |SELECTLEADER]]
|x1= <sqf>group player selectLeader player;</sqf>
[[Category:Scripting Commands ArmA|SELECTLEADER]]
 
[[Category:Command_Group:_Groups|{{uc:{{PAGENAME}}}}]]
|x2= Make unit a leader from server:
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
<sqf>[group _unit, _unit] remoteExec ["selectLeader", groupOwner group _unit];</sqf>
 
|seealso= [[commandFollow]] [[doFollow]] [[formationLeader]] [[formLeader]] [[isFormationLeader]] [[leader]] [[setLeader]]
}}

Latest revision as of 16:14, 13 May 2022

Hover & click on the images for description

Description

Description:
Select the group's leader. Group locality can be checked with local command and group ownership with groupOwner command.
An invalid combination can be provided to this command, e.g unitName not being part of group. In that case:
  • unitName will be leader of group, but will not be able to command them
  • if unitName is deleted or killed, leader of group will be objNull and will not automatically be reassigned.
Groups:
Groups

Syntax

Syntax:
group selectLeader unitName
Parameters:
group: Group
unitName: Object
Return Value:
Nothing

Examples

Example 1:
group player selectLeader player;
Example 2:
Make unit a leader from server:
[group _unit, _unit] remoteExec ["selectLeader", groupOwner group _unit];

Additional Information

See also:
commandFollow doFollow formationLeader formLeader isFormationLeader leader setLeader

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