On Menu (Flowgraph Node)

Overview

• Node Name: On Menu
• Category: repeat_instant
• File: extensions/flowgraph/nodes/util/onMenu.lua

Detects when the ESC/pause menu is open or closed, providing both continuous state and one-shot impulse outputs.

Pin Schema

Input Pins

Output Pins

Internals

Key Methods

Menu Detection

Uses core_input_bindings.getMenuActionMapEnabled() combined with a not core_gamestate.loading() check to determine if the ESC menu is open.

How It Works

1. Each frame, checks if the menu action map is enabled and the game is not in a loading state.
2. Sets open/close flow pins and the openOrClosed boolean to reflect current state.
3. Compares against lastState to detect transitions:
   • "none" → "opened": fires onOpened impulse
   • "opened" → "closed": fires onClosed impulse
4. Impulse pins are reset to false on the next frame after firing.
5. The reset input pin allows manually resetting the state tracking.

Usage Example

-- Pause game systems when menu opens:
-- [On Menu] → onOpened → [Pause Timer]
--           → onClosed → [Resume Timer]

-- Block input while menu is active:
-- [On Menu] → open → [Disable Player Controls]
--           → close → [Enable Player Controls]

Key Dependencies

• core_input_bindings.getMenuActionMapEnabled() - checks if the menu action map is active
• core_gamestate.loading() - checks if the game is in a loading state

See Also

• Route Distance (Flowgraph Node) - Related reference
• Closest Road (Flowgraph Node) - Related reference
• Custom Lua (Flowgraph Node) - Related reference
• FlowGraph Guide - Guide