Skip to reference

Beta reference. Prepared from development builds for this version. This reference does not describe the current stable release.

A verified stable reference is not available yet. Choose a prepared beta version above.

Do · Actions · supported

Master Overlay

Switch the dynamic Master Overlay source to an existing Overlay Builder overlay.

action.change_master_overlay · 2.8.0

Browse all entries

Requirements and availability

A saved Overlay Builder source and running master overlay.

Picker contexts: automation, timer, command, pad.

Behavior

Switch the master overlay to a saved Overlay Builder source with the selected transition; requires a saved source.

Configure in the app

Open: Do → Advanced Actions (commands only) → Add action

Steps

  1. Choose action category Change Theme, select Master Overlay, and click Add action.
  2. Expand the action card. Configure the Fields below; check Editor defaults for your context and any operation-dependent fields.
  3. Choose resource values from real app pickers. Set output Platform separately from the trigger Where setting when the action offers it.
  4. Use Move action up / Move action down to position this action, then save the containing command, automation, timer or SheevPad button.

Limitations

  • Picker availability does not supply missing event variables. Check prerequisites and originating provider.
  • An action return value is not automatically a sequence variable. Only documented producers create template outputs.

Fields

FieldInput / optionsDefaults / limitsAvailability
Master Overlay target
overlaySlug
theme_select

Options: overlay_builder.saved_overlays

Editor defaults: {"automation":"","timer":"","command":"","pad":""}

Literal value / selected resource
Transition
transitionStyle
select
  • None: none
  • Fade: fade

Declared UI default: none

Editor defaults: {"automation":"none","timer":"none","command":"none","pad":"none"}

Literal value / selected resource
Transition time (ms)
transitionMs
number

Declared UI default: 0

Editor defaults: {"automation":0,"timer":0,"command":0,"pad":0}

Min: 0

Max: 30000

Literal value / selected resource

Contract details

Declared Contexts
[
  "timer",
  "automation",
  "command",
  "pad"
]
Picker Contexts
[
  "automation",
  "timer",
  "command",
  "pad"
]
Hidden From Picker
false
Required Variables
[]
Failure Behavior
See the behavior for local skips/errors and context entries for sequence continuation.
Outputs
[]

Examples

Illustrative configuration; replace fixture resources in the editor. This is not an import file.

{
  "overlaySlug": "fixture-overlay",
  "transitionStyle": "none",
  "transitionMs": 0
}

Related entries

Source and verification

Source-reviewed for 2.8.0. Connected-service validation remains subject to release UAT.

  • src/features/automations.js — ACTION_REGISTRY.change_master_overlay
  • public/index.html — getBuilderActionEntries / createDefaultAction

Source revision: 472fb34b484eeef0b663d28cacb628a7b9f14ff1

Downloads and AI prompt
Download JSONDownload Markdown