> ## Knowledge Base Index
> Fetch the complete knowledge base index at: https://documentation.celestory.io/sitemap.xml
> Use this file to discover available pages before exploring further.
> Pure-Markdown content can be obtained by appending a '.md' suffix to the content URLs listed in the sitemap (without the trailing slash).

# ⬜ Open menu

# ⬜ Open menu

${frame}[Video: anatomy of the Open menu block](https://celestory-docs-videos.netlify.app/en/anatomie-bloc/openmenu.html)

![Open menu](https://celestory-docs-illustrations.netlify.app/en/Openmenu_EN.svg)

The Open Menu block allows you to dynamically display a preconfigured menu interface in your Celestory project, such as a main menu, an inventory or a custom popup.

This block is particularly useful for triggering pop-up interfaces without interrupting the main flow of the experience, such as displaying an options menu or inventory overlay.

## 📥 Entries

- in (Flow): Entry point triggering the opening of the selected menu.
- menu (Menu): Selection of the menu to display among those configured in the project (available types: "Main", "Custom", "Overlay/overlay").

## 📤 Outings

- out (Flow): Exit point activated once the menu open instruction has been processed, allowing the logical flow to continue.

## 💡 Example of use

Scenario: Show a menu of options when pressing the Escape key

1. The user presses the Escape key during a gaming session.
1. A trigger detects this action and activates the Open Menu block.
1. In the menu entry, select the "Options" menu previously configured as an overlay.
1. The options menu appears immediately on the screen, without interrupting the background flow.
1. The out flow can be used to temporarily disable certain interactions while the menu is open.

## ⚙️ Technical Details

- Management of menu types: Menus opened via this block can be of type main, custom or overlay, but do not manage HUD menus (treated separately).
- Asynchronous behavior: The out flow is activated immediately after opening the menu, without waiting for it to close. Background logic continues to run while the menu is displayed.

---

*Documented version: v1*