Creator Docs

Push Overlay

Push Overlay shows a layout on top of the screen. This layout is called an overlay. For example, an overlay can be the menu or the save screen. The visual novel stays on the same line under it.

Push Overlay is a system action. A system action runs when the reader does something. So it is not in the Actions menu of the scene editor. You add it in these places:

  • A key, a click, or a tap in a control
  • A click on an element in a layout

For example, a right-click in a control can open the menu.

Push Overlay has one setting.

Setting What it does
Layout The layout to show on top of the screen. You can choose any layout in your project.

Add Push Overlay to a click

You can add it to an element of a layout or of a control. Both editors work the same way.

  1. Open the layout or the control. See Layouts or Controls.

  2. Select the element that the reader should click.

  3. Next to Actions, tap the + button.

  4. Tap Click. The Actions list opens.

  5. In the Actions list, find Layers. Scroll down if you do not see it.

  6. Tap Push Overlay.

    The Actions list on a phone. Push Overlay is the first item under Layers, and it is marked. The Actions list on desktop. Push Overlay is the first item under Layers, and it is marked.

    The Push Overlay form opens.

  7. Tap Choose a layout.

  8. In the list, tap the layout you want. For example, tap Menu Page.

    The Push Overlay form on a phone with the list of layouts open. Menu Page is marked. The Push Overlay form on desktop with the list of layouts open. Menu Page is marked.
  9. Tap Submit.

Good to know

  • Run Push Overlay again to stack more overlays. Pop Overlay closes the top one.
  • An overlay blocks clicks on the screen under it.
  • Give the overlay a button that runs Pop Overlay, such as a Return button. Then the reader can close it.

Next steps