ctrlActivate: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Armed[ _]Assault(\|.*)]]" to "{{GameCategory|arma1|Scripting Commands}}")
m (Text replacement - "<sqf>([^↵][^<]*↵[^<]*)<\/sqf>" to "<sqf> $1 </sqf>")
 
(51 intermediate revisions by 4 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= GUI Control |GROUP1=
|game3= arma2oa
____________________________________________________________________________________________
|version3= 1.50


| Launch actions attached to given (button based) control. <br>
|game4= tkoh
Command only triggers '''action''' entry described in control config and engine-based actions (cancel or ok codes) and will not trigger button related [[User_Interface_Event_Handlers|User Interface Event Handlers]].<br>
|version4= 1.00
Command ignores control disabled state. (Example 2)
|DESCRIPTION=
____________________________________________________________________________________________


| '''ctrlActivate''' controlName|SYNTAX=
|game5= arma3
|version5= 0.50


|p1= controlName: [[Control]] |PARAMETER1=
|gr1= GUI Control


| [[Nothing]] |RETURNVALUE=
|descr= Launches action attached to given (button based) control. Command ignores control disabled state. (Example 2). Main syntax command only triggers engine-based actions (cancel or ok codes) and will not trigger button related [[User_Interface_Event_Handlers|User Interface Event Handlers]] or [[buttonAction]], use the alternative syntax for this. "ButtonClick" UI event handler will also be triggered with the alternative syntax. Use [[isUIContext]] to distinguish between scripted activation and user activation.<br>
____________________________________________________________________________________________
|s1= [[ctrlActivate]] control
 
|x1= <code>[[ctrlActivate]] _control</code> |EXAMPLE1=
|x2= <code>_control [[ctrlEnable]] false;
[[ctrlActivate]] _control; // Action fired.
</code> |EXAMPLE2=
____________________________________________________________________________________________


| [[allControls]], [[allDisplays]], [[controlsGroupCtrl]], [[ctrlDelete]], [[ctrlModel]], [[ctrlSetModel]], [[ctrlPosition]], [[ctrlSetPosition]], [[ctrlClassName]], [[ctrlModelScale]], [[ctrlSetModelScale]], [[ctrlModelDirAndUp]], [[ctrlSetModelDirAndUp]], [[displayParent]]  |SEEALSO=
|p1= control: [[Control]]


}}
|r1= [[Nothing]]


<h3 style="display:none">Notes</h3>
|s2= control [[ctrlActivate]] full
<dl class="command_description">
|s2since= arma3 2.18
<!-- Note Section BEGIN -->
|p21= control: [[Control]] - button based control ([[CT_BUTTON]], [[CT_XBUTTON]], [[CT_SHORTCUTBUTTON]], [[CT_ACTIVETEXT]])
|p22= full: [[Boolean]] - [[true]] to simulate button click in full including UI event handling
|r2= [[Nothing]]


<!-- Note Section END -->
|x1= <sqf>ctrlActivate _control;</sqf>
</dl>
|x2= <sqf>
_control ctrlEnable false;
ctrlActivate _control; // Action fired.
</sqf>


<h3 style="display:none">Bottom Section</h3>
|seealso= [[allControls]] [[allDisplays]] [[controlsGroupCtrl]] [[ctrlDelete]] [[ctrlModel]] [[ctrlSetModel]] [[ctrlPosition]] [[ctrlSetPosition]] [[ctrlClassName]] [[ctrlModelScale]] [[ctrlSetModelScale]] [[ctrlModelDirAndUp]] [[ctrlSetModelDirAndUp]] [[displayParent]]
 
}}
[[Category:Scripting Commands|CTRLACTIVATE]]
{{GameCategory|arma1|Scripting Commands}}
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]

Latest revision as of 19:42, 3 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:
Launches action attached to given (button based) control. Command ignores control disabled state. (Example 2). Main syntax command only triggers engine-based actions (cancel or ok codes) and will not trigger button related User Interface Event Handlers or buttonAction, use the alternative syntax for this. "ButtonClick" UI event handler will also be triggered with the alternative syntax. Use isUIContext to distinguish between scripted activation and user activation.
Groups:
GUI Control

Syntax

Syntax:
ctrlActivate control
Parameters:
control: Control
Return Value:
Nothing

Alternative Syntax

Syntax:
control ctrlActivate full
Parameters:
control: Control - button based control (CT_BUTTON, CT_XBUTTON, CT_SHORTCUTBUTTON, CT_ACTIVETEXT)
full: Boolean - true to simulate button click in full including UI event handling
Return Value:
Nothing

Examples

Example 1:
ctrlActivate _control;
Example 2:
_control ctrlEnable false; ctrlActivate _control; // Action fired.

Additional Information

See also:
allControls allDisplays controlsGroupCtrl ctrlDelete ctrlModel ctrlSetModel ctrlPosition ctrlSetPosition ctrlClassName ctrlModelScale ctrlSetModelScale ctrlModelDirAndUp ctrlSetModelDirAndUp displayParent

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=ctrlActivate&oldid=369263"