effectiveCommander: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Take[ _]On[ _]Helicopters(\|.*)?\]\]" to "{{GameCategory|tkoh|Scripting Commands}}")
(Add example)
 
(29 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma1 |Game name=
|game1= arma1
|version1= 1.00


|1.00|Game version=
|game2= arma2
|version2= 1.00


|gr1= Unit Control |GROUP1=
|game3= arma2oa
____________________________________________________________________________________________
|version3= 1.50


| Returns the effective commander of the vehicle. Effective commander is the player whom driver AI will listen to. So if in a tank there is a gunner and a commander and AI driver, if the [[effectiveCommander]] is gunner, then gunner pressing WASD will give AI orders to move. If gunner jumps out and then enters tank again, the [[effectiveCommander]] role most likely has changed to commander that remained in tank. Also the assignment seems to work on first come first served basis. |DESCRIPTION=
|game4= tkoh
____________________________________________________________________________________________
|version4= 1.00


| '''effectiveCommander''' vehicle |SYNTAX=
|game5= arma3
|version5= 0.50


|p1= vehicle: [[Object]] |PARAMETER1=
|gr1= Unit Control


| [[Object]] - commander unit |RETURNVALUE=
|descr= Returns the effective commander of the vehicle. Effective commander is the player whom driver AI will listen to.
So if in a tank there is a gunner and a commander and AI driver, if the [[effectiveCommander]] is gunner, then gunner pressing {{Controls|W}} {{Controls|A}} {{Controls|S}} {{Controls|D}} will give AI orders to move.
If gunner jumps out and then enters a tank again, the [[effectiveCommander]] role most likely has changed to commander that remained in tank. Also the assignment seems to work on first come first served basis.


|s1= [[effectiveCommander]] vehicle


|x1= <code>_commander = [[effectiveCommander]] tank;
|p1= vehicle: [[Object]]
</code>|EXAMPLE1=
____________________________________________________________________________________________


| [[setEffectiveCommander]], [[commander]], [[driver]], [[gunner]], [[currentPilot]], [[vehicleMoveInfo]]  |SEEALSO=
|r1= [[Object]] - commander unit


|x1= <sqf>
_unit = driver tank;
_effectiveCommander = effectiveCommander _unit; // returns the tank driver itself
_effectiveCommander = effectiveCommander tank; // returns the effective commander (commander or gunner or driver)
_effectiveCommander = effectiveCommander vehicle _unit; // identical to the one above - use [[vehicle]] if only the unit is known
</sqf>
|seealso= [[setEffectiveCommander]] [[commander]] [[driver]] [[gunner]] [[currentPilot]] [[vehicleMoveInfo]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Scripting Commands|EFFECTIVECOMMANDER]]
{{GameCategory|arma1|Scripting Commands}}
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}

Latest revision as of 19:56, 15 September 2024

Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
Hover & click on the images for description

Description

Description:
Returns the effective commander of the vehicle. Effective commander is the player whom driver AI will listen to. So if in a tank there is a gunner and a commander and AI driver, if the effectiveCommander is gunner, then gunner pressing W A S D will give AI orders to move. If gunner jumps out and then enters a tank again, the effectiveCommander role most likely has changed to commander that remained in tank. Also the assignment seems to work on first come first served basis.
Groups:
Unit Control

Syntax

Syntax:
effectiveCommander vehicle
Parameters:
vehicle: Object
Return Value:
Object - commander unit

Examples

Example 1:
_unit = driver tank; _effectiveCommander = effectiveCommander _unit; // returns the tank driver itself _effectiveCommander = effectiveCommander tank; // returns the effective commander (commander or gunner or driver) _effectiveCommander = effectiveCommander vehicle _unit; // identical to the one above - use vehicle if only the unit is known

Additional Information

See also:
setEffectiveCommander commander driver gunner currentPilot vehicleMoveInfo

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
Retrieved from "https://community.bistudio.com/wiki?title=effectiveCommander&oldid=369524"