Skip to main content
Version: 2.x

Widget configuration

Setting Type and Sub Key​

Every setting widget references a Setting Type asset and an optional Sub Key to identify which setting to control. See Setting Types for details on how widgets link to settings.

Auto-save and auto-apply​

Control when setting changes take effect and are persisted:

  • Auto Save (bAutoSave = true): Changes save and apply immediately
  • Auto Apply (bAutoApply = true): Changes preview immediately but don't save until manual save
  • Manual (both false): Changes require manual apply and save

When to use:

  • Auto Save - Useful for simplicity. Turn off if you want a separate save/discard system with Save and Cancel buttons.
  • Auto Apply - Good in most scenarios for immediate feedback. Turn off for settings that take time to apply (resolution, window mode) to avoid annoying users as they browse options.

Options​

Select setting widgets (ComboBox, Spinner, ButtonGroup) need options to choose from.

Static Options: Define options directly on the widget in the Details panel. Good for fixed choices like quality levels.

Option Sources: Use OptionSource for dynamic options that change at runtime.

Built-in source:

  • ResolutionOptionSource - Available display resolutions

You can create custom Option Sources in Blueprint by inheriting from SettingOptionSource and implementing the GetOptions function to return your custom options.