Skip to content

Commit

Permalink
MPFDisplay allow_empty documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
avanwinkle committed Apr 29, 2024
1 parent 4b34813 commit 00b28c2
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/gmc/reference/mpf-display.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,16 @@ All `MPFDisplay` instances must be first-level child nodes of the main `MPFWindo

The Godot Editor *Inspector* panel provides the following parameters for the `MPFDisplay` node:

### allow_empty:

Single value, type: `bool`. Default `false`

If enabled, this display will render an empty screen if all slides are removed. If disabled (default), this display will persist the current slide even after its removal has been requested, until a new slide is triggered.

This is useful for situations where the game is shifting from one mode to another, and the running mode stops before the new mode starts. The ending mode's *clear* event will trigger the slide to be removed some fraction of a second before the starting mode's *mode_(name)_started* event triggers the new slide to be shown.

That scenario would result in a brief flash of a blank display, which is not desirable for most users. By disabling `allow_empty`, the outgoing slide will remain in the display until the next one replaces it.

### is_default:

Single value, type: `bool`. Default: `false`
Expand Down

0 comments on commit 00b28c2

Please sign in to comment.