ctrlShow: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Arma[ _]2(\|.*)\]\]" to "{{GameCategory|arma2|Scripting Commands}}")
(added extra helpful informative feature to be 100% clear about the behaviour of ctrlShow.)
 
(24 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| ofp |Game name=
|game1= ofp
|version1= 1.75


|1.5|Game version=
|game2= ofpe
|version2= 1.00


|arg= local |Multiplayer Arguments=
|game3= arma1
|version3= 1.00


|eff= local |Multiplayer Effects=
|game4= arma2
|version4= 1.00


|gr1= GUI Control |GROUP1=
|game5= arma2oa
____________________________________________________________________________________________
|version5= 1.50


| Set if a control of the currently active user dialog is shown or not.
|game6= tkoh
|version6= 1.00


Read [[Arma: GUI Configuration]] for more information about user dialogs and controls. |DESCRIPTION=
|game7= arma3
____________________________________________________________________________________________
|version7= 0.50


| [[ctrlShow]] [idc, show] |SYNTAX=
|arg= local


|p1= [idc, show]: [[Array]] |PARAMETER1=
|eff= local


|p2= idc: [[Number]] - control ID |PARAMETER2=
|gr1= GUI Control


|p3= show: [[Boolean]] - true if the control should be shown, false if not |PARAMETER3=
|descr= Shows or hides a control, or group of controls together with all the controls inside that group of controls.<br>
Read [[Arma: GUI Configuration]] for more information about user dialogs and controls.<br>
{{ Feature | Informative | <sqf inline>ctrlShow</sqf> '''will hide or show every single control inside a ControlsGroup, even if they are placed inside of a ControlsGroup, which itself is inside of a ControlsGroup and so on.'''<br>Keep that in mind when designing a Graphical User Interface. }}


| [[Nothing]] |RETURNVALUE=
|s1= [[ctrlShow]] [idc, show]
____________________________________________________________________________________________


|s2= controlName [[ctrlShow]] show |Alternative Syntax=
|p1= idc: [[Number]] - control IDC


|p21= controlName: [[Control]] |PARAMETER21=
|p2= show: [[Boolean]] - for showing, use [[true]]. for hiding, use [[false]].


|p22= show: [[Boolean]] |Parameter22=
|r1= [[Nothing]]


|r2= [[Nothing]] |RETURNVALUE2=
|s2= controlName [[ctrlShow]] show
____________________________________________________________________________________________
 
|x1= <code>[[ctrlShow]] [100, [[false]]];</code> |EXAMPLE1=


|x2= <code>_control [[ctrlShow]] [[false]];</code> |EXAMPLE2=
|p21= controlName: [[Control]]
____________________________________________________________________________________________


| [[ctrlVisible]], [[ctrlShown]], [[ctrlEnable]] |SEEALSO=
|p22= show: [[Boolean]]
}}


<h3 style="display:none">Notes</h3>
|r2= [[Nothing]]
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|x1= <sqf>ctrlShow [100, false];</sqf>
</dl>


<h3 style="display:none">Bottom Section</h3>
|x2= <sqf>_control ctrlShow false;</sqf>


[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
|seealso= [[ctrlVisible]] [[ctrlShown]] [[ctrlEnable]]
[[Category:Scripting Commands OFP 1.96|{{uc:{{PAGENAME}}}}]]
}}
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
{{GameCategory|arma1|Scripting Commands}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]

Latest revision as of 13:49, 21 April 2024

Hover & click on the images for description

Description

Description:
Shows or hides a control, or group of controls together with all the controls inside that group of controls.
Read Arma: GUI Configuration for more information about user dialogs and controls.
ctrlShow will hide or show every single control inside a ControlsGroup, even if they are placed inside of a ControlsGroup, which itself is inside of a ControlsGroup and so on.
Keep that in mind when designing a Graphical User Interface.
Groups:
GUI Control

Syntax

Syntax:
ctrlShow [idc, show]
Parameters:
idc: Number - control IDC
show: Boolean - for showing, use true. for hiding, use false.
Return Value:
Nothing

Alternative Syntax

Syntax:
controlName ctrlShow show
Parameters:
controlName: Control
show: Boolean
Return Value:
Nothing

Examples

Example 1:
ctrlShow [100, false];
Example 2:
_control ctrlShow false;

Additional Information

See also:
ctrlVisible ctrlShown ctrlEnable

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