Step 8 Blueprint API

Step 8: Blueprint API

UOkMenuLibrary - opening the menu

Node	What it does
Toggle Settings Menu	Opens when closed, closes when open
Open Settings Menu	Opens (returns the widget); Pause Game and ZOrder pins
Close Settings Menu	Closes and restores input, cursor and pause
Is Settings Menu Open	True while this player's menu is open
Get Settings Menu	The open menu widget, or null
Set Player Camera Fov	Locks the camera FOV - the pair of the Video.FieldOfView delegate row

All take a Player Controller (auto-filled inside controller Blueprints).

UOkSettingsSubsystem - values & state

Get Game Instance → Get Subsystem (Ok Settings Subsystem):

• Staging: Set Staged Bool/Float/Int/Option, Get Staged ..., Has Staged Changes
• Committing: Apply Staged Changes, Revert Staged Changes, Reset Category To Defaults, Reset All To Defaults, Get Saved Value
• Availability: Is Setting Available, Is Option Available, Is Setting Enabled (edit conditions)
• Video safety: Confirm Video Changes, Cancel Video Changes + On Video Confirmation Required / Ended events
• Rebinding: Start Key Capture, Cancel Key Capture, Get Bound Key, Reapply Input Contexts
• Custom settings: Get Delegate Applier (→ On Setting Applied, On Trigger Executed), Replay Delegate Settings
• Restart tracking: Has Pending Restart
• Events: On Setting Changed, On Staged Value Changed, On Applied, On Setting Enabled Changed

UOkSettingsMenuWidget - the menu itself

Rebuild Menu, Select Category / Get Active Tab Index, Get Category Page, Find Row, Set Search Text / Count Visible Rows, Get Tab Count / Get Total Row Count, Set Key Bind Device, and the On Close Requested event.

Project settings (Plugins → OptiKit)

Setting	Default
Definition Scan Paths	/OptiKit
Autosave On Change	Off
Video Confirm Countdown Seconds	15
Audio Backend	Sound Class Mix
Default Theme	DA_OkThemeDefault
Text Library	(shipped DA_OkTexts)
Menu Widget Class	shipped WBP_OkSettingsMenu
Menu Close Keys	Escape, Gamepad B, platform back
Rebind Capture Timeout Seconds	5
Reserved Rebind Keys	Escape + gamepad navigation keys

Editor tools

• Tools → OptiKit → Check Settings Catalog - full validation (-run=OkCatalogCheck headless, exit 1 on problems)
• -run=OkCatalogBuild / -run=OkThemeBuild / -run=OkDemoBuild - regenerate the shipped catalog, theme widgets and demo map (regeneration overwrites the generated assets - work on copies)
• Automation RunTests OptiKit - the 84-test suite

Back to Home · Settings Reference