ctrlShow: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
(added extra helpful informative feature to be 100% clear about the behaviour of ctrlShow.)
 
(42 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


| Set if a control of the currently active user dialog is shown or not.
|game5= arma2oa
|version5= 1.50


Read [[Dialog Control]] for more information about user dialogs and controls. |DESCRIPTION=
|game6= tkoh
____________________________________________________________________________________________
|version6= 1.00


| '''ctrlShow''' [idc, show] |SYNTAX=
|game7= arma3
|version7= 0.50


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


|p2= idc: [[Integer]] - control ID |PARAMETER2=
|eff= local


|p3= show: [[Boolean]] - true if the control should be shown, false if not |PARAMETER3=
|gr1= GUI Control


| [[Nothing]] |RETURNVALUE=
|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. }}


|s2= controlName '''ctrlShow''' show |= Alternative Syntax
|s1= [[ctrlShow]] [idc, show]


|p21= controlName: [[Control]] |=
|p1= idc: [[Number]] - control IDC


|p22= show: [[Boolean]] |=
|p2= show: [[Boolean]] - for showing, use [[true]]. for hiding, use [[false]].


|r2= [[Nothing]] |RETURNVALUE=
|r1= [[Nothing]]
____________________________________________________________________________________________
 
|x1= <code>[[ctrlShow]] [100, [[false]] ];</code> |EXAMPLE1=


|x2= <code>_control [[ctrlShow]] [[false]];</code> |EXAMPLE2=
|s2= controlName [[ctrlShow]] show
____________________________________________________________________________________________


| [[ctrlVisible]], [[ctrlShown]], [[ctrlEnable]] |SEEALSO=
|p21= controlName: [[Control]]


}}
|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|CTRLSHOW]]
|seealso= [[ctrlVisible]] [[ctrlShown]] [[ctrlEnable]]
[[Category:Scripting Commands OFP 1.99|CTRLSHOW]]
}}
[[Category:Scripting Commands OFP 1.96|CTRLSHOW]]
[[Category:Scripting Commands ArmA|CTRLSHOW]]
[[Category:Command_Group:_GUI_Control|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[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