formationLeader: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
 
m (Text replacement - "<sqf>([^↵][^\/]*↵[^\/]*)<\/sqf>" to "<sqf> $1 </sqf>")
 
(71 intermediate revisions by 10 users not shown)
Line 1: Line 1:
[[Category:Scripting Commands|HINTCARRAY]]
{{RV|type=command
[[Category:Scripting Commands ArmA|HINTCARRAY]]


|game1= arma1
|version1= 1.00


<h2 style="color:#000066">''title '' ''' hintC  '' [text1, text2, ...]'''''</h2>
|game2= arma2
|version2= 1.00


|game3= arma2oa
|version3= 1.50


'''Operand types:'''
|game4= tkoh
|version4= 1.00


'''title''': [[String]]
|game5= arma3
   
|version5= 0.50
'''[text1, text2, ...]''': [[Array]]


'''Type of returned value:'''
|gr1= Unit Control


[[Nothing]]
|descr= Return leader of the formation.


'''Compatibility:'''
|s1= [[formationLeader]] unitName


Version 2.01 required.
|p1= unitName: [[Object]]


'''Description:'''
|r1= [[Object]]


Creates a hint dialog with the given title and text. Texts can be plain or structured.
|x1= <sqf>
if (formationLeader player != leader player) then
{
hint "Formation leader is not the group leader.";
};
</sqf>
 
|seealso= [[commandFollow]] [[doFollow]] [[formLeader]] [[isFormationLeader]] [[leader]] [[selectLeader]] [[setLeader]]
}}
 
<dl class="command_description">
 
<dt></dt>
<dd class="notedate">Posted on 2006-12-02 - 00:46</dd>
<dt class="note">[[User:Kronzky|Kronzky]]</dt>
<dd class="note">Return value is <NULL-OBJECT> if no group members exist.</dd>
 
</dl>

Latest revision as of 11:34, 3 September 2024

Hover & click on the images for description

Description

Description:
Return leader of the formation.
Groups:
Unit Control

Syntax

Syntax:
formationLeader unitName
Parameters:
unitName: Object
Return Value:
Object

Examples

Example 1:
if (formationLeader player != leader player) then { hint "Formation leader is not the group leader."; };

Additional Information

See also:
commandFollow doFollow formLeader isFormationLeader leader selectLeader 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
Posted on 2006-12-02 - 00:46
Kronzky
Return value is <NULL-OBJECT> if no group members exist.