commandingMenu: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Take[ _]On[ _]Helicopters(\|.*)?]]" to "{{GameCategory|tkoh|Scripting Commands}}")
m (Some wiki formatting)
 
(38 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma2 |Game name=
|game1= arma2
|version1= 1.00


|1.00|Game version=
|game2= arma2oa
|version2= 1.50


|gr1= Interaction |GROUP1=
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| Returns the name of the topmost commanding menu or "" if the menu is closed. For action menu visibility check see [[isActionMenuVisible]]. |DESCRIPTION=
|game4= arma3
____________________________________________________________________________________________
|version4= 0.50


| '''commandingMenu''' |SYNTAX=
|gr1= Interaction


|p1= |PARAMETER1=
|descr= Returns the name of the topmost commanding menu or "" if the menu is closed. For action menu visibility check see [[isActionMenuVisible]]. See {{Link|#Notes}} for {{arma2}}/{{arma3}} structure.


|p2= |PARAMETER2=  
|s1= [[commandingMenu]]


|p3= |PARAMETER3=  
|r1= [[String]]


| [[String]] |RETURNVALUE=  
|x1= <sqf>
waitUntil { sleep 0.1; commandingMenu == "RscStatus" };
hint "Press 4, I'm bleeding !";
</sqf>


|x2= <sqf>if (commandingMenu != "") then { hint "Command menu is opened" };</sqf>


|x1= <code>[[waitUntil]] {[[commandingMenu]] <nowiki>==</nowiki> "RscStatus"}; [[hint]] "Press 4, I'm bleeding !";</code>|EXAMPLE1=
|seealso= [[showCommandingMenu]] [[isActionMenuVisible]] [[BIS_fnc_addCommMenuItem]] [[BIS_fnc_removeCommMenuItem]]
}}


|x2= <code>[[if]] ([[commandingMenu]] != "") [[then]] { [[hint]] "Command menu is opened" };</code>|EXAMPLE2=
{{Note
 
|user= Lou Montana
____________________________________________________________________________________________
|timestamp= 20090715122100
 
|text= {{arma2}} possible values are:
| [[showCommandingMenu]], [[isActionMenuVisible]], [[BIS_fnc_addCommMenuItem]], [[BIS_fnc_removeCommMenuItem]] |SEEALSO=
* '''""''' - means the menu is closed
* '''"RscMainMenu"''' - Main menu, by pressing backspace
** '''"RscMoveHigh"''' - Move menu (1)
** '''"#WATCH"''' - Watch menu (2)
*** '''"#WATCH0"''' - Watch menu - next page (2-0)
** '''"RscWatchDir"''' - Engage menu (3)
*** '''"RscWatchMoreDir"''' - Engage menu - watch a direction (3-8)
** '''"#GET_IN"''' - Mount menu (4)
** '''"RscStatus"''' - Status menu (5)
*** '''"RscCallSupport"''' - Mount menu - call support (5-1)
** '''"#ACTION"''' - Action menu (6)
** '''"RscCombatMode"''' - Combat mode menu (7)
** '''"RscFormations"''' - Formation menu(8)
** '''"RscTeam"''' - Team menu (9)
*** '''"RscSelectTeam"''' - Team menu - select team (0-5)
** '''"RscReply"''' - Reply menu (0)
*** '''"#User:BIS_Menu_GroupCommunication"''' - Communication menu (0-8)
*** '''"#CUSTOM_RADIO"''' - Custom sounds menu (0-9)
** '''"RscRadio"''' - Radio menu (0-0)
* '''"RscGroupRootMenu"''' - "simplified" menu
}}


| |MPBEHAVIOUR=  
{{Note
____________________________________________________________________________________________
|user= Lou Montana
|timestamp= 20210802074200
|text= {{arma3}} possible values (thanks to '''RCA3'''):
* '''""''' - means the menu is closed
* '''"RscGroupRootMenu"''' Group menu root
** '''"RscMenuMove"''' (1) Move menu
** '''"#WATCH"''' (2) Watch menu
*** '''"#WATCH1"''' (2-0) Watch menu - next page
** '''"RscMenuEngage"''' (3) Engage menu
*** '''"RscMenuWatchDir"''' (3-8) Engage menu - watch a direction
** '''"#GET_IN"''' (4) Mount menu
** '''"RscMenuStatus"''' (5) Status menu
*** '''"RscCallSupport"''' (5-1) Status menu - call support
** '''"#ACTION"''' (6) Action menu Action menu
** '''"RscMenuCombatMode"''' (7) Combat mode menu
** '''"RscMenuFormations"''' (8) Formation menu
** '''"RscMenuTeam"''' (9) Team menu
*** '''"RscMenuSelectTeam"''' (9-9) Team menu - select team
** '''"RscMenuReply"''' (0) Reply menu
*** '''"#User:BIS_fnc_addCommMenuItem_menu"''' (0-8) BIS Supports
*** '''"#CUSTOM_RADIO"''' (0-9) Custom radio
*** '''"RscRadio"''' (0-0) Radio menu
** '''"RscMainMenu"''' (Backspace) Main menu
}}
}}
<h3 style='display:none'>Notes</h3>
<dl class='command_description'>
<!-- Note Section BEGIN -->
<dd class="notedate">Posted on July 15, 2009 - 12:21 (CEST)
<dt class="note">[[User:Lou Montana|Lou Montana]]
<dd class="note">
Possible values are :
*'''""''' - means menu is closed
*'''"RscMainMenu"''' - Main menu, by pressing backspace
**'''"RscMoveHigh"''' - Move menu (1)
**'''"#WATCH"''' - Watch menu (2)
***'''"#WATCH0"''' - Watch menu - next page (2-0)
**'''"RscWatchDir"''' - Engage menu (3)
***'''"RscWatchMoreDir"''' - Engage menu - watch a direction (3-8)
**'''"#GET_IN"''' - Mount menu (4)
**'''"RscStatus"''' - Status menu (5)
***'''"RscCallSupport"''' - Mount menu - call support (5-1)
**'''"#ACTION"''' - Action menu (6)
**'''"RscCombatMode"''' - Combat mode menu (7)
**'''"RscFormations"''' - Formation menu(8)
**'''"RscTeam"''' - Team menu (9)
***'''"RscSelectTeam"''' - Team menu - select team (0-5)
**'''"RscReply"''' - Reply menu (0)
***'''"#User:BIS_Menu_GroupCommunication"''' - Communication menu (0-8)
***'''"#CUSTOM_RADIO"''' - Custom sounds menu (0-9)
**'''"RscRadio"''' - Radio menu (0-0)
*'''"RscGroupRootMenu"''' - "simplified" menu
<!-- Note Section END -->
</dl>
<h3 style='display:none'>Bottom Section</h3>
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 02:04, 10 February 2023

Logo 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:
Returns the name of the topmost commanding menu or "" if the menu is closed. For action menu visibility check see isActionMenuVisible. See Notes for Arma 2/Arma 3 structure.
Groups:
Interaction

Syntax

Syntax:
commandingMenu
Return Value:
String

Examples

Example 1:
waitUntil { sleep 0.1; commandingMenu == "RscStatus" }; hint "Press 4, I'm bleeding !";
Example 2:
if (commandingMenu != "") then { hint "Command menu is opened" };

Additional Information

See also:
showCommandingMenu isActionMenuVisible BIS_fnc_addCommMenuItem BIS_fnc_removeCommMenuItem

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
Lou Montana - c
Posted on Jul 15, 2009 - 12:21 (UTC)
Arma 2 possible values are:
  • "" - means the menu is closed
  • "RscMainMenu" - Main menu, by pressing backspace
    • "RscMoveHigh" - Move menu (1)
    • "#WATCH" - Watch menu (2)
      • "#WATCH0" - Watch menu - next page (2-0)
    • "RscWatchDir" - Engage menu (3)
      • "RscWatchMoreDir" - Engage menu - watch a direction (3-8)
    • "#GET_IN" - Mount menu (4)
    • "RscStatus" - Status menu (5)
      • "RscCallSupport" - Mount menu - call support (5-1)
    • "#ACTION" - Action menu (6)
    • "RscCombatMode" - Combat mode menu (7)
    • "RscFormations" - Formation menu(8)
    • "RscTeam" - Team menu (9)
      • "RscSelectTeam" - Team menu - select team (0-5)
    • "RscReply" - Reply menu (0)
      • "#User:BIS_Menu_GroupCommunication" - Communication menu (0-8)
      • "#CUSTOM_RADIO" - Custom sounds menu (0-9)
    • "RscRadio" - Radio menu (0-0)
  • "RscGroupRootMenu" - "simplified" menu
Lou Montana - c
Posted on Aug 02, 2021 - 07:42 (UTC)
Arma 3 possible values (thanks to RCA3):
  • "" - means the menu is closed
  • "RscGroupRootMenu" Group menu root
    • "RscMenuMove" (1) Move menu
    • "#WATCH" (2) Watch menu
      • "#WATCH1" (2-0) Watch menu - next page
    • "RscMenuEngage" (3) Engage menu
      • "RscMenuWatchDir" (3-8) Engage menu - watch a direction
    • "#GET_IN" (4) Mount menu
    • "RscMenuStatus" (5) Status menu
      • "RscCallSupport" (5-1) Status menu - call support
    • "#ACTION" (6) Action menu Action menu
    • "RscMenuCombatMode" (7) Combat mode menu
    • "RscMenuFormations" (8) Formation menu
    • "RscMenuTeam" (9) Team menu
      • "RscMenuSelectTeam" (9-9) Team menu - select team
    • "RscMenuReply" (0) Reply menu
      • "#User:BIS_fnc_addCommMenuItem_menu" (0-8) BIS Supports
      • "#CUSTOM_RADIO" (0-9) Custom radio
      • "RscRadio" (0-0) Radio menu
    • "RscMainMenu" (Backspace) Main menu
Retrieved from "https://community.bistudio.com/wiki?title=commandingMenu&oldid=337562"