SystemMenuOverlay Class Reference

Shared Escape menu for non-gameplay screens. More...

#include <SystemMenuOverlay.hpp>

Collaboration diagram for SystemMenuOverlay:

Public Member Functions
void	open ()
	Open the system menu on its root page.
void	close ()
	Close the menu and discard transient settings state.
bool	isOpen () const
	True while the overlay is active.
void	handleEscape (const UserSettings &settings)
	Handle Escape while the overlay is active.
bool	consumeEvent (const SDL_Event &event)
	Consume input events while the overlay owns focus.
SystemMenuOverlayResult	render (UserSettings &settings, std::string_view settingsPath)
	Draw the overlay and return any commands emitted this frame.

Private Attributes
bool	open_ = false
SettingsEditor	settingsEditor_
ConfirmModal	confirm_

Detailed Description

Shared Escape menu for non-gameplay screens.

Member Function Documentation

close()

void SystemMenuOverlay::close

(

)

Close the menu and discard transient settings state.

Here is the call graph for this function:

Here is the caller graph for this function:

consumeEvent()

bool SystemMenuOverlay::consumeEvent

(

const SDL_Event &

event

)

Consume input events while the overlay owns focus.

Here is the caller graph for this function:

handleEscape()

void SystemMenuOverlay::handleEscape

(

const UserSettings &

settings

)

Handle Escape while the overlay is active.

Here is the call graph for this function:

Here is the caller graph for this function:

isOpen()

bool SystemMenuOverlay::isOpen ( ) const

nodiscard

True while the overlay is active.

Here is the caller graph for this function:

open()

void SystemMenuOverlay::open

(

)

Open the system menu on its root page.

Here is the call graph for this function:

Here is the caller graph for this function:

render()

SystemMenuOverlayResult SystemMenuOverlay::render	(	UserSettings &	settings,
		std::string_view	settingsPath )

Draw the overlay and return any commands emitted this frame.

Here is the call graph for this function:

Member Data Documentation

confirm_

ConfirmModal SystemMenuOverlay::confirm_

private

open_

bool SystemMenuOverlay::open_ = false

private

settingsEditor_

SettingsEditor SystemMenuOverlay::settingsEditor_

private

---

The documentation for this class was generated from the following files:

• src/client/menus/settings/SystemMenuOverlay.hpp
• src/client/menus/settings/SystemMenuOverlay.cpp