enableCopilot: 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>")
 
(33 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma3 |Game name=
|game1= tkoh
|version1= 1.01


|0.50|Game version=
|game2= arma3
|version2= 0.50


|arg= global |Multiplayer Arguments=
|arg= global
|eff= local |Multiplayer Effects=


|gr1= Object Manipulation |GROUP1=
|eff= local
____________________________________________________________________________________________


| Enables copilot actions, toggles availability of the actions related to copilots, such as taking over controls, suspending controls, etc. This command triggers <tt>"ControlsShifted"</tt> event handler.<br><br>
|gr1= Object Manipulation
{{Informative | In multiplayer, execute this command globally to have it synced on all clients}}|DESCRIPTION=


____________________________________________________________________________________________
|descr= Enables copilot actions, toggles availability of the actions related to copilots, such as taking over controls, suspending controls, etc. This command triggers the {{hl|"ControlsShifted"}} event handler.


| vehicle '''enableCopilot''' enable |SYNTAX=
|mp= Execute this command globally (e.g with [[remoteExec]]) to have it synced on all clients.


|p1= vehicle: [[Object]] - vehicle on which to toggle copilot actions  |PARAMETER1=
|s1= vehicle [[enableCopilot]] enable
|p2= enable: [[Boolean]] - enable or disable |PARAMETER2=


| [[Nothing]] |RETURNVALUE=
|p1= vehicle: [[Object]] - vehicle on which to toggle copilot actions


|p2= enable: [[Boolean]] - enable or disable


|x1= <code>[[if]] (![[isCopilotEnabled]] myHeli) [[then]] { myHeli [[enableCopilot]] [[true]] };
|r1= [[Nothing]]
</code>|EXAMPLE1=


____________________________________________________________________________________________
|x1= <sqf>
if (!isCopilotEnabled myHeli) then
{
myHeli enableCopilot true;
};
</sqf>


| [[isCopilotEnabled]], [[currentPilot]] |SEEALSO=
|seealso= [[isCopilotEnabled]] [[currentPilot]]
}}


|  |MPBEHAVIOUR=  
<dl class="command_description">
____________________________________________________________________________________________
}}


<h3 style='display:none'>Notes</h3>
<dt><dt>
<dl class='command_description'>
<dd class="notedate">Posted on 2014-02-17</dd>
<!-- Note Section BEGIN -->
<dt class="note">[[User:Strangepete|Strangepete]]</dt>
<dd class="notedate">Posted on February 17, 2014
<dd class="note">Only enables the user actions, not who is in control - pilot can lock or unlock co-pilot controls in multiplayer while still true.
<dt class="note">[[User:Strangepete|Strangepete]]
* Actions: [[Arma 3: Actions#LockVehicleControl|LockVehicleControl]], [[Arma 3: Actions#UnlockVehicleControl|UnlockVehicleControl]], [[Arma 3: Actions#SuspendVehicleControl|SuspendVehicleControl]] and [[Arma 3: Actions#TakeVehicleControl|TakeVehicleControl]]
<dd class="note">Only enables the user actions, not who is in control - pilot can lock or unlock co-pilot controls in multiplayer while still true.<br>
* You can use the [[Arma 3: Event Handlers#ControlsShifted|Arma 3 Event Handler - ControlsShifted]] to detect [[Arma 3: Actions#TakeVehicleControl|Take]] and [[Arma 3: Actions#SuspendVehicleControl|Release]] actions.</dd>
* Actions: [[Arma_3:_Actions#LockVehicleControl|LockVehicleControl]], [[Arma_3:_Actions#UnlockVehicleControl|UnlockVehicleControl]], [[Arma_3:_Actions#SuspendVehicleControl|SuspendVehicleControl]] and [[Arma_3:_Actions#TakeVehicleControl|TakeVehicleControl]]<br>
* You can use the [[Arma 3: Event Handlers#ControlsShifted|Arma 3 Event Handler - ControlsShifted]] to detect [[Arma_3:_Actions#TakeVehicleControl|Take]] and [[Arma_3:_Actions#SuspendVehicleControl|Release]] actions  


<!-- Note Section END -->
</dl>
</dl>
<h3 style='display:none'>Bottom Section</h3>
[[Category:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Vehicle_Assignment|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Object_Manipulation|{{uc:{{PAGENAME}}}}]]

Latest revision as of 11:34, 3 September 2024

Hover & click on the images for description

Description

Description:
Enables copilot actions, toggles availability of the actions related to copilots, such as taking over controls, suspending controls, etc. This command triggers the "ControlsShifted" event handler.
Multiplayer:
Execute this command globally (e.g with remoteExec) to have it synced on all clients.
Groups:
Object Manipulation

Syntax

Syntax:
vehicle enableCopilot enable
Parameters:
vehicle: Object - vehicle on which to toggle copilot actions
enable: Boolean - enable or disable
Return Value:
Nothing

Examples

Example 1:
if (!isCopilotEnabled myHeli) then { myHeli enableCopilot true; };

Additional Information

See also:
isCopilotEnabled currentPilot

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 2014-02-17
Strangepete
Only enables the user actions, not who is in control - pilot can lock or unlock co-pilot controls in multiplayer while still true.