Builtin Library
- ..
- README.md2.4 KB
- about.yaml406 B
- behavior.luau5.5 KB
- inspector.luau2.7 KB
- template
- type.yaml2.0 KB
README.md
editorLayout
An editor dock arrangement as an asset: a <name>.editorLayout/ folder whose
layout.yaml names either the panels the arrangement holds, each with the
region it seeds into, or a captured arrangement in dock.json that the Save
layout dialog wrote from the live dock. Registering an instance adds it to the
editor shell's layout list, so it applies by name from the Window menu, the
editor.layout tool, or --layout <name> at boot.
# recording.editorLayout/layout.yaml
title: Recording # the name the layout switch shows
title_key: layouts.recording.title # optional: a catalog key; the switch reads the title from the catalogs in the editor's language
description: The scene and the first agent's terminal side by side.
description_key: layouts.recording.description # optional: the same for the description
slot: a # optional: a | b, the side of the layout switch this layout stands for until a person assigns another
mode: full # full | simple: simple keeps the layout's panel set; a panel that registers later waits in the Window menu
toolstrip: shown # optional: hidden takes the gizmo buttons, who-is-here counters and live indicator off screen
panels:
- { id: viewport, dock: center }
- { id: agent, dock: right }
fractions: { right: 0.42 }
The editor switches between two layouts, side A and side B. A layout declaring
slot: a or slot: b is what that side stands for until a person assigns
another layout to it; the shell keeps the person's choice per world on their
own machine. A world layout of the same name stands in for the built-in one.
title_key and description_key name catalog messages, looked up in the
world's locales/, then the editor's own, then the library's. While a catalog
holds the key, the Window menu and the layout switch show its message in the
editor's language; otherwise they show title and description as written.
A layout the editor ships lives in the built-in library; one a person saves
lives in the world at /zero/source/editor/layouts/. Both are the same asset,
and a world layout of the same name stands in for the built-in one.
In the Inspector
Layout: the layout's title, description, switch side and mode, whether it carries a captured dock, each panel it places and where, and Apply layout, which arranges the editor this way (and says why when it cannot).