showCommandingMenu: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
Lou Montana (talk | contribs) m (Some wiki formatting) |
||
(60 intermediate revisions by 11 users not shown) | |||
Line 1: | Line 1: | ||
{{ | {{RV|type=command | ||
| arma2 |= | |game1= arma2 | ||
|version1= 1.00 | |||
|1. | |game2= arma2oa | ||
|version2= 1.50 | |||
| | |game3= tkoh | ||
|version3= 1.00 | |||
| | |game4= arma3 | ||
|version4= 0.50 | |||
| | |gr1= Interaction | ||
| [[ | |descr= Create the commanding menu described by the given config class or menu name. When the name is empty, the current menu is hidden.<br><br> | ||
If commanding menu has "expression" set up, the expression will receive the following arguments when user activated the menu item: | |||
* Local variable {{hl|_target}}: [[Object]] - Target under the cursor. This works in both 3D and 2D (when cursor is over the unit icon on the map). | |||
* Local variable {{hl|_pos}}: [[Array]] - Cursor position. | |||
* Local variable {{hl|_is3D}}: [[Boolean]] - [[false]] if cursor is over the map, otherwise [[true]]. | |||
| | |s1= [[showCommandingMenu]] name | ||
|p1= name: [[String]] - class name or user menu name (with "#USER:" prefix and "_#" page number suffix, where # is the page number starting with 0). | |||
| [[ | |r1= [[Nothing]] | ||
| | |x1= <sqf>showCommandingMenu "";</sqf> | ||
|x2= <sqf>showCommandingMenu "MyClassName";</sqf> | |||
|x3= <sqf>showCommandingMenu "#USER:Tag_Menu_myMenu_0";</sqf> | |||
|x4= <sqf>showCommandingMenu "RscMainMenu";</sqf> | |||
|seealso= [[commandingMenu]] [[Arma 3: Communication Menu]] [[BIS_fnc_createMenu]] | |||
}} | }} | ||
{{Note | |||
< | |user= LaKing | ||
//This script will create a custom menu, and display it once. | |timestamp= 20100125172000 | ||
|text= <sqf> | |||
// This script will create a custom menu, and display it once. | |||
MY_SUBMENU_inCommunication = | MY_SUBMENU_inCommunication = | ||
[ | [ | ||
["User submenu", | ["User submenu", true], | ||
["Option-1", [2], "", -5, [["expression", "player sidechat ""-1"" "]], "0", "0"], | ["Option-1", [2], "", -5, [["expression", "player sidechat ""-1"" "]], "0", "0", "\ca\ui\data\cursor_support_ca"], | ||
["Option 0", [3], "", -5, [["expression", "player sidechat "" 0"" "]], "1", "0"], | ["Option 0", [3], "", -5, [["expression", "player sidechat "" 0"" "]], "1", "0", "\ca\ui\data\cursor_support_ca"], | ||
["Option 1", [4], "", -5, [["expression", "player sidechat "" 1"" "]], "1", " | ["Option 1", [4], "", -5, [["expression", "player sidechat "" 1"" "]], "1", "CursorOnGround", "\ca\ui\data\cursor_support_ca"] | ||
]; | ]; | ||
MY_MENU_inCommunication = | MY_MENU_inCommunication = | ||
[ | [ | ||
// First array: "User menu" This will be displayed under the menu, bool value: has Input Focus or not. | // First array: "User menu" This will be displayed under the menu, bool value: has Input Focus or not. | ||
["User menu",false], | // Note that as to version Template:arma2 1.05, if the bool value set to false, Custom Icons will not be displayed. | ||
["User menu", false], | |||
// Syntax and semantics for following array elements: | // Syntax and semantics for following array elements: | ||
// ["Title_in_menu", [assigned_key], "Submenu_name", | // ["Title_in_menu", [assigned_key], "Submenu_name", CMD, [<nowiki/>["expression",script-string]], "isVisible", "isActive" <, optional icon path>] | ||
// Title_in_menu: string that will be displayed for the player | // Title_in_menu: string that will be displayed for the player | ||
// Assigned_key: 0 - no key, 1 - escape key, 2 - key-1, 3 - key-2, ... , 10 - key-9, 11 - key-0, 12 and up... the whole keyboard | // Assigned_key: 0 - no key, 1 - escape key, 2 - key-1, 3 - key-2, ... , 10 - key-9, 11 - key-0, 12 and up... the whole keyboard | ||
// Submenu_name: User menu name string (eg "#USER:MY_SUBMENU_NAME" ), "" for script to execute. | // Submenu_name: User menu name string (eg "#USER:MY_SUBMENU_NAME" ), "" for script to execute. | ||
// script: command to be executed on activation. (no arguments passed) | // CMD: (for main menu:) CMD_SEPARATOR -1; CMD_NOTHING -2; CMD_HIDE_MENU -3; CMD_BACK -4; (for custom menu:) CMD_EXECUTE -5 | ||
// isVisible - Boolean 1 or 0 for yes or no | // script-string: command to be executed on activation. (no arguments passed) | ||
// isActive - Boolean 1 or 0 for yes or no - if item is not active, it appears gray. | // isVisible - Boolean 1 or 0 for yes or no, - or optional argument string, eg: "CursorOnGround" | ||
// isActive - Boolean 1 or 0 for yes or no - if item is not active, it appears gray. | |||
// optional icon path: The path to the texture of the cursor, that should be used on this menuitem. | |||
["First", [0], "", -5, [["expression", "player sidechat ""First"" "]], "1", "1"], | ["First", [0], "", -5, [["expression", "player sidechat ""First"" "]], "1", "1"], | ||
["Second", [2], "", -5, [["expression", "player sidechat ""Second"" "]], "1", "1"], | ["Second", [2], "", -5, [["expression", "player sidechat ""Second"" "]], "1", "1"], | ||
Line 62: | Line 72: | ||
showCommandingMenu "#USER:MY_MENU_inCommunication"; | showCommandingMenu "#USER:MY_MENU_inCommunication"; | ||
</ | </sqf> | ||
Appendix, list of optional argument strings: | |||
{{Columns|4| | |||
* {{hl|AmmoLow}} | |||
* {{hl|AreActions}} | |||
* {{hl|CanAnswer}} | |||
* {{hl|CanDeselectTeamFromBar}} | |||
* {{hl|CanDeselectUnitFromBar}} | |||
* {{hl|CanDeselectVehicleFromBar}} | |||
* {{hl|CanSelectTeamFromBar}} | |||
* {{hl|CanSelectUnitFromBar}} | |||
* {{hl|CanSelectVehicleFromBar}} | |||
* {{hl|CommandsToGunner}} | |||
* {{hl|CommandsToPilot}} | |||
* {{hl|CursorOnEmptyVehicle}} | |||
* {{hl|CursorOnEnemy}} | |||
* {{hl|CursorOnFriendly}} | |||
* {{hl|CursorOnGround}} | |||
* {{hl|CursorOnGroupMember}} | |||
* {{hl|CursorOnGroupMemberSelected}} | |||
* {{hl|CursorOnHoldingFire}} | |||
* {{hl|CursorOnNeedFirstAID}} | |||
* {{hl|CursorOnNeedHeal}} | |||
* {{hl|CursorOnNotEmptySubgroups}} | |||
* {{hl|CursorOnVehicleCanGetIn}} | |||
* {{hl|FormationDiamond}} | |||
* {{hl|FormationLine}} | |||
* {{hl|FuelLow}} | |||
* {{hl|HasRadio}} | |||
* {{hl|HCCanDeselectTeamFromBar}} | |||
* {{hl|HCCanDeselectUnitFromBar}} | |||
* {{hl|HCCanSelectTeamFromBar}} | |||
* {{hl|HCCanSelectUnitFromBar}} | |||
* {{hl|HCCursorOnIcon}} | |||
* {{hl|HCCursorOnIconenemy}} | |||
* {{hl|HCCursorOnIconSelectable}} | |||
* {{hl|HCCursorOnIconSelectableSelected}} | |||
* {{hl|HCIsLeader}} | |||
* {{hl|HCNotEmpty}} | |||
* {{hl|Injured}} | |||
* {{hl|IsAlone}} | |||
* {{hl|IsAloneInVehicle}} | |||
* {{hl|IsCommander}} | |||
* {{hl|IsLeader}} | |||
* {{hl|IsSelectedToAdd}} | |||
* {{hl|IsTeamSwitch}} | |||
* {{hl|IsWatchCommanded}} | |||
* {{hl|IsXbox}} | |||
* {{hl|Multiplayer}} | |||
* {{hl|NotEmpty}} | |||
* {{hl|NotEmptyBlueTeam}} | |||
* {{hl|NotEmptyCommanders}} | |||
* {{hl|NotEmptyGreenTeam}} | |||
* {{hl|NotEmptyInVehicle}} | |||
* {{hl|NotEmptyMainTeam}} | |||
* {{hl|NotEmptyRedTeam}} | |||
* {{hl|NotEmptySoldiers}} | |||
* {{hl|NotEmptySubgroups}} | |||
* {{hl|NotEmptyYellowTeam}} | |||
* {{hl|PlayableLeader}} | |||
* {{hl|PlayableSelected}} | |||
* {{hl|PlayerOwnRadio}} | |||
* {{hl|PlayerVehicleCanGetIn}} | |||
* {{hl|SelectedTeam}} | |||
* {{hl|SelectedUnit}} | |||
* {{hl|SomeSelectedHaveTarget}} | |||
* {{hl|SomeSelectedHoldingFire}} | |||
* {{hl|VehicleCommander}} | |||
}} | |||
}} | |||
{{Note | |||
|user= SilentSpike | |||
|timestamp= 20160723154000 | |||
|text= You can combine the argument strings (see the above note) together to create OR conditions. | |||
Hence {{hl|"HasRadioIsLeader"}} is true when the unit is a leader or has a radio. | |||
}} |
Latest revision as of 19:31, 7 April 2024
Description
- Description:
- Create the commanding menu described by the given config class or menu name. When the name is empty, the current menu is hidden.
If commanding menu has "expression" set up, the expression will receive the following arguments when user activated the menu item: - Groups:
- Interaction
Syntax
- Syntax:
- showCommandingMenu name
- Parameters:
- name: String - class name or user menu name (with "#USER:" prefix and "_#" page number suffix, where # is the page number starting with 0).
- Return Value:
- Nothing
Examples
- Example 1:
- showCommandingMenu "";
- Example 2:
- showCommandingMenu "MyClassName";
- Example 3:
- showCommandingMenu "#USER:Tag_Menu_myMenu_0";
- Example 4:
- showCommandingMenu "RscMainMenu";
Additional Information
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 Jan 25, 2010 - 17:20 (UTC)
-
Appendix, list of optional argument strings:// This script will create a custom menu, and display it once. MY_SUBMENU_inCommunication = [ ["User submenu", true], ["Option-1", [2], "", -5, [["expression", "player sidechat ""-1"" "]], "0", "0", "\ca\ui\data\cursor_support_ca"], ["Option 0", [3], "", -5, [["expression", "player sidechat "" 0"" "]], "1", "0", "\ca\ui\data\cursor_support_ca"], ["Option 1", [4], "", -5, [["expression", "player sidechat "" 1"" "]], "1", "CursorOnGround", "\ca\ui\data\cursor_support_ca"] ]; MY_MENU_inCommunication = [ // First array: "User menu" This will be displayed under the menu, bool value: has Input Focus or not. // Note that as to version Template:arma2 1.05, if the bool value set to false, Custom Icons will not be displayed. ["User menu", false], // Syntax and semantics for following array elements: // ["Title_in_menu", [assigned_key], "Submenu_name", CMD, [["expression",script-string]], "isVisible", "isActive" <, optional icon path>] // Title_in_menu: string that will be displayed for the player // Assigned_key: 0 - no key, 1 - escape key, 2 - key-1, 3 - key-2, ... , 10 - key-9, 11 - key-0, 12 and up... the whole keyboard // Submenu_name: User menu name string (eg "#USER:MY_SUBMENU_NAME" ), "" for script to execute. // CMD: (for main menu:) CMD_SEPARATOR -1; CMD_NOTHING -2; CMD_HIDE_MENU -3; CMD_BACK -4; (for custom menu:) CMD_EXECUTE -5 // script-string: command to be executed on activation. (no arguments passed) // isVisible - Boolean 1 or 0 for yes or no, - or optional argument string, eg: "CursorOnGround" // isActive - Boolean 1 or 0 for yes or no - if item is not active, it appears gray. // optional icon path: The path to the texture of the cursor, that should be used on this menuitem. ["First", [0], "", -5, [["expression", "player sidechat ""First"" "]], "1", "1"], ["Second", [2], "", -5, [["expression", "player sidechat ""Second"" "]], "1", "1"], ["Submenu", [3], "#USER:MY_SUBMENU_inCommunication", -5, [["expression", "player sidechat ""Submenu"" "]], "1", "1"] ]; showCommandingMenu "#USER:MY_MENU_inCommunication";
- AmmoLow
- AreActions
- CanAnswer
- CanDeselectTeamFromBar
- CanDeselectUnitFromBar
- CanDeselectVehicleFromBar
- CanSelectTeamFromBar
- CanSelectUnitFromBar
- CanSelectVehicleFromBar
- CommandsToGunner
- CommandsToPilot
- CursorOnEmptyVehicle
- CursorOnEnemy
- CursorOnFriendly
- CursorOnGround
- CursorOnGroupMember
- CursorOnGroupMemberSelected
- CursorOnHoldingFire
- CursorOnNeedFirstAID
- CursorOnNeedHeal
- CursorOnNotEmptySubgroups
- CursorOnVehicleCanGetIn
- FormationDiamond
- FormationLine
- FuelLow
- HasRadio
- HCCanDeselectTeamFromBar
- HCCanDeselectUnitFromBar
- HCCanSelectTeamFromBar
- HCCanSelectUnitFromBar
- HCCursorOnIcon
- HCCursorOnIconenemy
- HCCursorOnIconSelectable
- HCCursorOnIconSelectableSelected
- HCIsLeader
- HCNotEmpty
- Injured
- IsAlone
- IsAloneInVehicle
- IsCommander
- IsLeader
- IsSelectedToAdd
- IsTeamSwitch
- IsWatchCommanded
- IsXbox
- Multiplayer
- NotEmpty
- NotEmptyBlueTeam
- NotEmptyCommanders
- NotEmptyGreenTeam
- NotEmptyInVehicle
- NotEmptyMainTeam
- NotEmptyRedTeam
- NotEmptySoldiers
- NotEmptySubgroups
- NotEmptyYellowTeam
- PlayableLeader
- PlayableSelected
- PlayerOwnRadio
- PlayerVehicleCanGetIn
- SelectedTeam
- SelectedUnit
- SomeSelectedHaveTarget
- SomeSelectedHoldingFire
- VehicleCommander
- Posted on Jul 23, 2016 - 15:40 (UTC)
- You can combine the argument strings (see the above note) together to create OR conditions. Hence "HasRadioIsLeader" is true when the unit is a leader or has a radio.