--- title: Battle Menus url: "https://orkframework.com/guide/ork4/ork4-documentation/section-menus/ork4-battle-menus/" updated: "2026-07-22" category: "Section: Menus" --- # Battle Menus Battle menus are used to select a combatant’s actions in battle. Battle menus are found in **Menus > Battle Menus**. The default battle menu that’ll be used is defined in the [battle system settings](https://orkframework.com/guide/ork4/ork4-documentation/section-battles/ork4-battle-systems/). Each individual battle system can optionally override the default battle menu. Additionally, combatants and classes can define using their own battle menus (also optionally separate definitions per battle system). Using a battle menu is optional – you can turn off automatically opening the battle menu when a player controlled combatant’s turn starts. In that case, you can optionally open it via a defined input key, or just rely on other means of action selection, e.g. control maps, shortcut HUDs or custom systems. If the battle menu is opened automatically or via an input key is set up in the battle system’s settings. # Base Settings Defines the basic settings of a battle menu, e.g. the used UI box. ## Content Settings Define the (optional) title and message of the battle menu and it’s sub menus. ## Sub-Menu Settings Optionally use different UI boxes for sub-menus, e.g. ability content type or item listings. Additionally, battle menus can be used in multi-mode – this means each sub-menu will be opened while the previous menu is still available. If disabled, opening a sub-menu will close the previous menu. ## Drag and Drop Optionally show tooltips and use actions by dragging them from the battle menu on targets in the scene. ## Audio Settings Battle menus can optionally play audio clips when they’re opened or closed. ## Target Selection Settings Define the target selection mode of the battle menu. Targets can either be selected after selecting an action (targets depending on action) or a target can be selected before actions (actions depending on target). ## Options Optionally remember previous selections, last targets and define how targets will be sorted. You can also automatically use actions on the combatant’s group/individual targets. Additionally, you can change the time scale while the battle menu is open, e.g. to slow down time during action selection. # Layout Settings Define how the battle menu will display it’s content. ## Content Layout The content layout manages how individual input buttons will display their content. The default setup will display the action’s info (e.g. use costs, quantities) in an additional content with the content ID *info*. ## Combatant Button Layout Optionally use a custom combatant button layout (default is set up in **Texts > Text Settings**). This is used by input buttons displaying combatants, e.g. by the target selection. The combatant buton layout can also use HUDs as templates to add additional content information, e.g. status values, value bars, etc. ## Header Texts Optionally display headers above input buttons. ## Portrait Settings Define if and which portraits are displayed in individual sub-menus. E.g. display portraits for items and abilities. ## Description Settings Optionally display a description for selected input buttons. # User Highlight Battle menus can highlight their user combatant. This allows using the same highlight options as highlighting targets – see the *Highlight Settings* in the [target settings documentation](https://orkframework.com/guide/ork4/ork4-documentation/section-battles/target-settings/) for details. # Options The battle menu’s options define which actions and sub-menus are available. The individual optionss can optionally depend on valid conditions, e.g. checking the user’s status, game states or variables. You can add custom options by deriving from the *BaseBattleMenuItem* class. ## Ability Lists the combatant’s abilities. Can optionally be separated into different content types or show a single, defined ability. Listing multiple abilities (or content types) will show them in a sub-menu. ## AI Ruleset Lists the combatant’s AI ruleset slots and allows changing the equipped AI rulesets. ## Attack The combatant’s base or counter attack. ## Auto Automatically selects a command using the combatant’s AI settings. ## Battle Menu Shows another battle menu. This allows creating complex battle menus. ## Change Member Lists the combatant group’s non-battle members and allows changing the combatant. ## Class (Single) Lists the combatant’s classes and allows changing the current single-class. ## Class Ability The combatant’s class ability (will only be displayed if a class ability is available). When multiple class abilities are available (e.g. due to using class slots and having multiple classes equipped), all class abilities will be listed. ## Class Slot Lists the combatant’s class slots and allows changing the equipped class (similar to the class slot menu). ## Command Give a member of the combatant’s group a command (i.e. the next action they should use). ## Defend Uses the combatant’s defend command. ## End Ends the combatant’s turn. ## Equipment Lists the combatant’s equipment slots and allows changing the equipment (similar to the equipment menu). ## Escape Uses the combatant’s escape command. ## Grid Examine Allows examining the battle’s grid. Only available in grid battles. Only available in grid battles. ## Grid Move Uses the combatant’s move command after selecting a grid cell as target. Only available in grid battles. Only available in grid battles. ## Grid Orientation Allows selecting the orientation (rotation) on a battle’s grid. Only available in grid battles. Only available in grid battles. ## Item Lists the combatant’s items. Can optionally be separated into different content types or show a single, defined item. Listing multiple items (or content types) will show them in a sub-menu. ## Menu Screen Shows a menu screen. ## Schematic Starts a schematic, using the battle menu user as ‘Machine Object’ and ‘Starting Object’. ## Selected Data (Shortcuts) Displays shortcuts stored in selected data. Each viable shortcut (e.g. an ability or item) will be displayed as it’s own button. ## Shortcut Slot Displays the shortcut assigned to a defined shortcut slot. Combine it with a *Battle Menu* option to list shortcut slots in a sub-menu. ## Switch Menu User Changes the menu user to the next/previous combatant that can show the battle menu. Only available in ‘Active Time’ and ‘Real Time’ battles. Only available in *Active Time* and *Real Time* type battle systems.