settings
Every setting the engine and its plugins declare, in pages. A page names a category, the table it is stored under, whether it belongs to the project or to this editor, and a schema in the same shape a component uses — so a settings page renders with the same code an inspector does. Values are held in memory until project_toml or editor_toml turns them back into the file they came from.
6 functions, 0 constants. Scripts reach it as settings::.
Functions
Argument kinds are the script values a call passes: node is a node handle, any a table or value of any kind, fn a callback.
| function | acts on | what it does |
|---|---|---|
editor_toml() -> any | — | The editor-scope settings as TOML, for a preferences file. |
get(string, string) -> any | — | One setting's value: what was set, else what the schema defaults to, else nil. |
load_project(string) -> any | — | Read every value out of a project.toml's text, so a page starts from what the project says. |
pages() -> any | — | Every declared page as { category, table, scope, schema }, in registration order. |
project_toml(string) -> any | — | The manifest text these settings would write, starting from the given text so anything they do not describe survives. |
set(string, string, any) -> any | — | Change one setting, in memory; write it out with project_toml or editor_toml. |