enableCopilot: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(add to command groups object manipulation & veh assignment; see also isCopilotEnabled; add example; add note clarifying mechanic)
m (Text replacement - "<sqf>([^↵][^\/]*↵[^\/]*)<\/sqf>" to "<sqf> $1 </sqf>")
 
(45 intermediate revisions by 6 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


| Enables copilot actions. |= Description
|arg= global


____________________________________________________________________________________________
|eff= local


| vehicle '''enableCopilot''' enable |= Syntax
|gr1= Object Manipulation


|p1= vehicle: [[Object]]  |= PARAMETER1
|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.


|p2= enable: [[Boolean]] |= PARAMETER2
|mp= Execute this command globally (e.g with [[remoteExec]]) to have it synced on all clients.


| [[Nothing]] |= RETURNVALUE
|s1= vehicle [[enableCopilot]] enable


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


|x1= <code>if ( ! [[isCopilotEnabled]] myHeli ) then { myHeli '''enableCopilot''' true; };
|p2= enable: [[Boolean]] - enable or disable
</code>|= EXAMPLE1


____________________________________________________________________________________________
|r1= [[Nothing]]


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


| |= MPBEHAVIOUR
|seealso= [[isCopilotEnabled]] [[currentPilot]]
____________________________________________________________________________________________
}}
}}


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


<!-- 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.