Frame

Self nodes for nl.frame. A Frame is a rectangle on one Page that renders another Page inside itself, so these nodes are how a running graph swaps what is on screen without leaving the Page the player is on — a tab strip, a settings pane, a router. Each one acts on the Frame whose blueprint it sits in, takes no Element input, and only appears in that Frame's own blueprint. To reach a different Frame, use its counterpart in Element.

Conventions

• Reads are pure, writes are latent. Every Get node here is Pure. Every Set node is Latent: the write goes through the host and resolves asynchronously.
• A Frame holds two things: a target Page and a params object. The target must be a Page; the card's dropdown lists Pages only, minus the Page this Frame lives on and any Page that would nest its way back to it. See Surfaces and Pages for what a Page is and how it differs from a Game UI Surface.
• params is the embedded Page's Page props. The Page inside the Frame reads a param it declares with Get Page Param in App, and the whole object with Get Page Props. A param that is not in params reads its default. In the editor, the Frame's Properties show one field per param of the target Page; see Page params. It answers back with Emit Page Event, which arrives at this Frame's Page Event head in Events.
• A write that changes nothing does nothing. Both writers compare the incoming target and params against the current ones, params by JSON equality, and return early when both match. Re-running them does not remount the Page or replay its enter animation.
• None of these run inside a Blueprint Value. The Get nodes are pure, but a Blueprint Value evaluates on a widgetValue owner and every node on this page is scoped to the Frame's main blueprint. To read the Frame from inside a Blueprint Value, place an Element literal for it and use the Element-category reader.
• The visible and enabled nodes are two families. While the palette is browsed, Get Visible and Get Enabled are one row, Get Visible or Enabled, and Set Visible and Set Enabled are Set Visible or Enabled. A search finds each node by its own name, and the ▾ beside a placed card's title switches between the two. See Node families.

Set Frame Page

blueprint.frameWidget.setTargetPage · Latent

Switches the Page this Frame shows, and optionally replaces its params in the same write. The swap runs through the Frame's Page animation — its own settings, or the target Page's when the Frame is set to inherit them.

On-card fields

When the picked Page declares params, the card grows one input per param in front of Page props, as on Go Page (see App). The values given, laid over Page props, replace the Frame's params. With no value given and Page props unwired, the params are kept.

While the Frame is changing page, presses inside it stop at the Frame. The page that is leaving takes no input, the arriving page's elements answer presses as usual, and nothing reaches the Frame's own heads, the elements around it, the Surface or App logic. Once the change has finished, presses pass up from the Frame again, as described in Event bubbling.

Get Target Page

blueprint.frameWidget.getTargetPage · Pure

Reads the id of the Page the Frame is currently showing. This is the Surface id stored in the document, not the name shown in the editor.

Set Params

blueprint.frameWidget.setParams · Latent

Replaces the params object handed to the embedded Page. It replaces — it does not merge — so build the whole object, reading the current one with Get Params first if you only mean to change a field.

The pin takes no on-card literal and has no fallback to the current value: executing this node with nothing wired writes {} and wipes the params.

Get Params

blueprint.frameWidget.getParams · Pure

Set Enabled

blueprint.frame.setEnabled · Latent

false disables interaction for the Frame. It stays rendered and laid out, and so does the Page inside it.

Booleans here take no on-card literal and fall back to the current value: with nothing wired, or an edge that resolves to null, the property is left as it is. A wired non-boolean counts as true only when it is the string "true" or "1".

Get Enabled

blueprint.frame.getEnabled · Pure

Set Visible

blueprint.frame.setVisible · Latent

visible false removes the Frame and the whole Page inside it from the runtime element tree — it is not a CSS hide. The embedded Page unmounts, every blueprint in it stops, and their Init runs again when the Frame comes back. A hidden Frame cannot show itself: something else has to call Set Frame Visible on it. Use Displayable Set Display when you want it hidden but mounted.

Get Visible

blueprint.frame.getVisible · Pure