ORK 4 RPG Framework Logo
  • ORK 4 GUIDE
    • Documentation
    • Tutorials
    • Extensions
    • API
  • ORK 3 GUIDE
    • Documentation
    • Tutorials
    • API
  • Support
  • Forum
  • Get ORK

ORK 4 Documentation

  • Getting Started
    • Welcome
    • First Steps (Unity)
  • Features
    • The Status System
    • Schematics
    • Schematic Nodes
    • Dialogue Importer
    • Variables
    • Selected Data
  • Components
    • Battle Components
    • Combatant Components
    • Control Components
    • Cursor Prefab Components
    • Game Starters
    • Interactable Components
    • Move AI Components
    • Scene Setup Components
  • Editor
    • The ORK 4 Editor
    • Sections & Sub-Sections
    • Node Editor
    • Schematic Editor
    • Asset Sources
    • Unity Overlay Toolbar
  • Section: System
    • System Settings
    • Languages
    • Organizer Types
    • Game States & Conditions
    • General Condition Templates
    • Object Pools
    • Prefab Savers
    • Scene Connections
  • Section: Controls
    • Game Controls
    • Interaction Settings
    • Player Controls
    • Camera Controls
    • Input Keys
    • Control Maps
    • Camera Positions
    • Battle Camera
  • Section: Gameplay
    • Game Settings
    • Formulas
    • Difficulties
    • Shortcut Slots & Settings
    • Custom Settings & Global Custom Settings
    • Global Machines
    • Machine Templates
  • Section: Status
    • Status Values
    • Status Effects
    • Attack Modifiers
    • Defence Modifiers
    • Abilities & Ability Developments
    • Status Developments
    • Research Trees
    • Damage Types
    • Status Bonuses & Templates
    • Status Condition Templates
  • Section: Inventory
    • Inventory Settings
    • Inventory Containers
    • Currencies
    • Items
    • AI Rulesets
    • Crafting Recipes
    • Equipment Slots & Slot Set Templates
    • Equipment & Available Equipment Templates
    • Shops
    • Loot
  • Section: Combatants
    • Combatants
    • Combatant Groups
    • Class Slots
    • Classes
    • Factions & Faction Benefits
    • Animations
    • Move AIs
    • Formations
    • Action Combos
  • Section: Battles
    • Battle Systems
    • Turn Based Battles
    • Active Time Battles
    • Real Time Battles
    • Phase Battles
    • Battle Spots
    • Battle AIs
    • Battle Actions Settings
    • Special Commands Settings
    • Target Settings
    • Target Selection Templates
    • Battle Range Templates
    • Battle Grid Settings
    • Battle Grid Highlights
    • Battle Grid Cell Types
    • Battle Grid Formations
  • Section: Content
    • Content Types
    • Music
    • Sound Templates
    • Areas
    • Teleports
    • Quests & Quest Tasks
    • Logs & Log Texts
    • Object Contents
  • Section: UI
    • UI Settings
    • UI Layers
    • UI Layouts
    • UI Boxes
    • HUDs
    • Notifications
    • Cursor Settings
  • Section: Menus
    • Start Menu
    • Save Game Settings
    • Option Categories
    • Menu Screens
    • Menu Requirements
    • Battle Menus
    • Loot Dialogues
    • Item Collection
    • Combatant Selections
    • Quantity Selections
    • Shop Layouts
  • Section: Texts
    • Text Settings
    • Formatting Settings
    • Flying Texts
    • Use Cost Display
    • Status Preview Display
    • Bonus Display
    • Status Change Display
    • Console Settings & Console Types
    • Text Codes
  • Sections: Editor
    • Editor Settings
    • Backups
    • Variables
    • Plugins
  • Scripting
    • Access Handler
    • Custom Nodes
    • Custom Save Data
    • Custom Component Save Data

ORK 4 Tutorials

  • ORK 4 Unity Quickstart Tutorials (3D)
    • ORK 4 Unity Quickstart 3D
    • 01 Initial ORK Setup
    • 02 Player Setup
    • 03 Music & Scenes
    • 04 UI System Setup
    • 05 UI Boxes
    • 06 Flying Texts
    • 07 Status Values
    • 08 Status Effects
    • 09 First Abilities
    • 10 Fighter Setup
    • 11 First Enemies & Battle AI
    • 12 Battle System Setup
    • 13 Animating Battle Start and End
    • 14 Random Battles
    • 15 Animating Actions
    • 16 Player Battle HUD
    • 17 Elemental Attacks
    • 18 Animating More Actions
    • 19 Inventory & Loot
    • 20 Equipment
    • 21 Loot, Start Equipment & Viewers
    • 22 Magic Abilities
    • 23 Caster Setup
    • 24 More Enemies
    • 25 Start Menu & Save Games
    • 26 Menu Screens
    • 27 Interactions
    • 28 Item Collectors
    • Quickstart Extended
  • Battle Tutorials
    • Active Time Battles
    • Phase Battles
    • Real TT 01 Real Time Battles & Tab Targeting
    • Real TT 02 Control Map, Use Ranges & Battle Area
    • Real TT 03 Camera Control, Battle AI & Reuse Time
    • Real TT 04 Damage Detection, Action Animation & Player HUD
    • Real TT 05 Switch Player & Final Adjustments
    • Hit & Miss
    • Critical Hits
    • Cast Time
    • Reuse Time
    • Grid 01: Battle Grid Setup
    • Grid 02: Highlights
    • Grid 03: Cell Types
    • Grid 04: Move Command
    • Grid 05: Scene Grid Setup
    • Grid 06: Battle Ready
    • Grid 07 Use & Affect Ranges
    • Grid 08: Better Camera Control
  • Gameplay Tutorials
    • Multiple Interaction Controllers
    • Player Group Spawn & Follow
    • Spawn Hunting Enemies
    • Gamepad Controls (Unity Input System)
    • Combined Inputs
    • Control Map for Keyboard (Shortcuts)
    • Control Map for Gamepad (Shortcuts)
    • Quests 01: Menu Screen
    • Quests 02: Hunting
    • Quests 03: Collect Potion Materials
    • Quests 04: Collect Equipment Materials
    • Quests 05: Quest Mark HUDs
    • Crafting 01: Menu Screen
    • Crafting 02: Materials & Recipes
    • Crafting 03: Getting Materials
    • Crafting 04: Proficiency & Critical Outcome
    • Shop
    • Inventory Containers
  • Schematics Tutorials
    • UI Animation Schematics
    • Flying Text Animation Schematics
    • HUD Conditional Schematics
  • UI Tutorials
    • Unity UI: Initial Setup
    • Unity UI: Status Value UI Setup
    • Unity UI: Status Effect UI Setup
    • Unity UI: Shortcut UI Setup
    • Unity UI: Dragging Notification
    • Unity UI: Interaction HUD
    • Unity UI: Shortcut HUD
    • Unity UI: Turn Order HUD
    • Unity UI: Cast Time HUD
    • Unity UI: Quest HUD
    • Unity UI: Tooltip HUD
    • Unity UI: Move Range HUD
    • Menus 01 UI Box Setup
    • Menus 02 Template HUDs
    • Menus 03 Menu Setup
    • Menus 04 Main Menu
    • Menus 05 Inventory
    • Menus 06 Equipment
    • Menus 07 Ability
    • Menus 08 Group
    • Menus 09 Quest
    • Menus 10 Crafting
  • Module 01: Status System
    • Introduction to Modular Tutorials
    • M01.1: Status Values
      • Introduction to Status Values
      • Health
      • Mana
      • Barrier
      • Base Experience
      • Class Experience
      • Spendable Experience
      • Normal Stats
    • M01.2: Modifiers
      • Introduction to Modifiers
      • Element
      • Attack Type
      • Size
      • Race
    • M01.3: Status Effects
      • Introduction to Status Effects
      • Buffs
      • Debuffs
      • Poison
      • Regeneration
      • Blind
      • Stun
      • Sleep
      • Silence
      • Enchants
      • Charm
      • Doom
      • Reflect
  • Module 02: Actions
    • Introduction to Actions
    • M02.1: Formulas
      • Introduction to Formulas
      • Physical Damage Formula
      • Magical Damage Formula
      • Hit Chance
      • Critical Chance
    • M02.2: Abilities
      • Introduction to Abilities
      • Base Attack
      • Elemental Magic Spells
      • Steal Ability
      • Drain
      • Healing Spell
      • Cure
      • Buff Abilities
      • Debuff Abilities

ORK 4 Extensions

  • Plugins
    • Save Game Compression Plugin
  • Schematic Nodes
    • Footstepper Nodes (Unity)
  • Scripts
    • A* Pathfinding Movement Component (Unity)
    • PolyNav 2D Movement Component (Unity)
    • Cinemachine Camera Control Type (Unity)
    • Rewired Input Key (Unity)
    • Unity Legacy Input Key (Unity)
    • Core GameKit Wrapper (Unity)
    • Pool Boss Wrapper (Unity)
View Categories
  • Guide
  • ORK 4
  • ORK 4 Documentation
  • Section: Menus

Battle Menus

0:00 / 5:34
  • View as Markdown Open this page as plain Markdown (opens in a new tab)
  • Open in ChatGPT Ask questions about this page (opens in a new tab)
  • Open in Claude Ask questions about this page (opens in a new tab)
  • Open in Google AI Studio Ask questions about this page (Google account required) (opens in a new tab)

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. 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 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.

Table of Contents
  • Base Settings
    • Content Settings
    • Sub-Menu Settings
    • Drag and Drop
    • Audio Settings
    • Target Selection Settings
    • Options
  • Layout Settings
    • Content Layout
    • Combatant Button Layout
    • Header Texts
    • Portrait Settings
    • Description Settings
  • User Highlight
  • Options
    • Ability
    • AI Ruleset
    • Attack
    • Auto
    • Battle Menu
    • Change Member
    • Class (Single)
    • Class Ability
    • Class Slot
    • Command
    • Defend
    • End
    • Equipment
    • Escape
    • Grid Examine
    • Grid Move
    • Grid Orientation
    • Item
    • Menu Screen
    • Schematic
    • Selected Data (Shortcuts)
    • Shortcut Slot
    • Switch Menu User
Sitemap
  • Showcase
  • ORK 4 Guide
    • Documentation
    • Tutorials
    • Extensions
    • API
  • ORK 3 Guide
    • Documentation
    • Tutorials
    • API
  • ORK 2 Hub
    • Tutorials
    • Plugins
    • API
  • Support
  • Forum
  • Get ORK
  • Contact
  • Blog
  • Makinom
  • gamingislove.com
Categories
  • News (75)
  • ORK 2 (137)
    • Tutorial (137)
      • Game tutorial (50)
      • Gameplay (32)
      • How-to (55)
  • Release (158)
Search

© 2015 Gaming is Love e.U.

Disclosure: This site may contain affiliate links, which means I may receive a commission if you click a link and purchase something that I have recommended. While clicking these links won’t cost you any money, they will help me fund my development projects while recommending great assets!