Skip to main content
Version: Next (dev)

Settings Menu

The plasma.gameui package provides a ready-made settings menu. Enable GameSettingsMenu on a UiCanvasComponent. Leaving UiDocument empty creates the built-in settings document.

The built-in document supports preset selection, display controls, audio, accessibility, Apply, Keep, Revert and Reset buttons and the confirmation countdown, using the canvas's existing mouse, keyboard and controller navigation. Deactivating or destroying the canvas cancels the preview it owns.

Supply a custom UiDocument to style and lay out the same flow for your game, including your own accessibility scale range.

Blackboard bindings​

A custom document communicates through the canvas local blackboard. Setting names replace dots with underscores.

BindingPurpose
Settings_Display_VSync, Settings_Audio_Master, ...Editable draft values
Settings_NextPreset, Settings_Apply, Settings_Confirm, Settings_Revert, Settings_ResetSetTrue click actions
Settings_Plus_<key>, Settings_Minus_<key>Step a numeric control
Settings_Label_<key>, Settings_Disabled_<key>, Settings_Reason_<key>Describe a control
Settings_PresetLabel, Settings_Status, Settings_Busy, Settings_ConfirmVisible, Settings_QualityDisabledDrive the flow

Use Settings_Disabled_<key> and Settings_Reason_<key> to grey out controls that the current window mode, backend or command line has locked, rather than letting input be silently ignored.

Accessibility consumers​

Text and interface scale affect canvases. Reduced motion removes state and hover transitions and freezes looping clips. Subtitles include a visibility and size preview in the built-in menu.

These consumers change presentation only. They do not modify the authored UI resource on disk.

See Also​