* docs: complete node editor node reference glossary (#107) - generated by new nodes.tools glossary subcommand, 47 categorized pages covering all 403 nodes, docstring gap fixes, help-agent docs-index entries * docs: fix Jinja2 Format discoverability - document dynamic-input template variables, move node to string page, link key inference from dynamic-input notes, strip links from index summaries * help agent: keep node reference out of the chat prompt - collapse glossary entries to one pointer line (~19k chars saved), agent retrieves node info via search_docs/read_doc tool calls * help agent: replace in-prompt docs index with find_docs lookup tool - prompt carries a 13-line section overview (~1.5k chars vs ~66k), pages located via keyword-scored find_docs at runtime * changelog: help agent prompt slimming + find_docs lookup * docs: sort node reference index and nav alphabetically by page title * review: move module constants into top-of-file constant blocks (glossary MAX_DEFAULT_LENGTH; docs SECTION_DESCRIPTIONS, _FIND_STOPWORDS, FIND_DOCS_LIMIT) * review: word-boundary find_docs scoring with plural/-ing folds, find_docs+section_overview unit tests, jinja2 template field description override * docs: help agent overview no longer claims an in-prompt index of all documentation pages * docs: full node docstring audit pass - 335 classes audited by 5 agents, ~89 accuracy fixes (nonexistent/misnamed sockets, wrong behavior claims), ~94 expansions, 5 factually-wrong PropertyField descriptions corrected, glossary regenerated
5.8 KiB
Event Nodes
Emit messages and status updates from graphs, and react to scene events with the Event listener node. See Events for the event system and the Events reference for every event a graph can listen to.
7 nodes.
| Node | Registry path |
|---|---|
| Emit Agent Message | event/EmitAgentMessage |
| Emit Scene Status | event/EmitSceneStatus |
| Emit Status | event/EmitStatus |
| Emit Status (Conditional) | event/EmitStatusConditional |
| Emit System Message | event/EmitSystemMessage |
| Emit World Editor Sync | event/EmitWorldEditorSync |
| Event | event/Event |
Emit Agent Message
event/EmitAgentMessage
Emits an agent message to the UX
Inputs
| Input | Type | Description |
|---|---|---|
state |
any |
The graph state |
message |
str |
(optional) The message text to emit |
agent |
agent,str |
(optional) The agent (agent object or agent name) |
header |
str |
(optional) The header of the message |
message_color |
str |
(optional) The color of the message |
meta |
dict |
(optional) The meta data of the message |
Outputs
| Output | Type | Description |
|---|---|---|
state |
any |
The state input, passed through |
emitted |
bool |
Whether the message was emitted (True) or not (False) |
Properties
| Property | Type | Default | Description |
|---|---|---|---|
message |
str |
"" |
The message text to emit |
agent |
str |
"" |
The agent the message is attributed to. Choices are generated at runtime. |
header |
str |
"" |
The header of the message |
message_color |
str |
"grey" |
The color of the message. Choices are generated at runtime. |
meta |
dict |
{} |
The meta data of the message |
Emit Scene Status
event/EmitSceneStatus
Emits the scene status object to the UX
Inputs
| Input | Type | Description |
|---|---|---|
state |
any |
The graph state |
Outputs
| Output | Type | Description |
|---|---|---|
state |
any |
The state input, passed through |
Emit Status
event/EmitStatus
Emits a status message
Inputs
| Input | Type | Description |
|---|---|---|
message |
str |
(optional) The message text to emit |
status |
str |
(optional) The status of the message |
as_scene_message |
bool |
Whether to emit the message as a scene message (optional) |
Outputs
| Output | Type | Description |
|---|---|---|
emitted |
bool |
Whether the message was emitted (True) or not (False) |
Properties
| Property | Type | Default | Description |
|---|---|---|---|
message |
str |
"" |
The message text to emit |
status |
str |
"info" |
The status of the message. Choices are generated at runtime. |
as_scene_message |
bool |
False |
Whether to emit the message as a scene message |
Emit Status (Conditional)
event/EmitStatusConditional
Emits a status message if a condition is met
Unlike EmitStatus, the state input is required, so the message is
only emitted when the state input actually receives a value -
connect it through a conditional branch to gate the emission.
Inputs
| Input | Type | Description |
|---|---|---|
state |
any |
The graph state |
message |
str |
(optional) The message text to emit |
status |
str |
(optional) The status of the message |
as_scene_message |
bool |
Whether to emit the message as a scene message (optional) |
Outputs
| Output | Type | Description |
|---|---|---|
state |
any |
The graph state |
emitted |
bool |
Whether the message was emitted (True) or not (False) |
Properties
| Property | Type | Default | Description |
|---|---|---|---|
message |
str |
"" |
The message text to emit |
status |
str |
"info" |
The status of the message. Choices are generated at runtime. |
as_scene_message |
bool |
False |
Whether to emit the message as a scene message |
Emit System Message
event/EmitSystemMessage
Emits a system message
Inputs
| Input | Type | Description |
|---|---|---|
state |
any |
The graph state |
message_title |
str |
The title of the message (optional) |
message |
str |
(optional) The message text to emit |
Outputs
| Output | Type | Description |
|---|---|---|
state |
any |
The graph state |
Properties
| Property | Type | Default | Description |
|---|---|---|---|
message_title |
str |
"" |
The title of the message |
message |
text |
"" |
The message text to emit |
font_color |
str |
"grey" |
The color of the message. Choices are generated at runtime. |
icon |
str |
"mdi-information" |
The icon of the message |
display |
str |
"text" |
Whether to display the message. Choices are generated at runtime. |
as_markdown |
bool |
False |
Whether to render the message as markdown |
Emit World Editor Sync
event/EmitWorldEditorSync
Sends a world editor sync message which on the UX side will cause the world editor to sync its state with the server
This is useful when the world editor needs to be updated with the latest state.
Inputs
| Input | Type | Description |
|---|---|---|
state |
any |
Outputs
| Output | Type | Description |
|---|---|---|
state |
any |
Event
event/Event
Returns the current event object when inside a Listen node module.
Outputs
| Output | Type | Description |
|---|---|---|
event |
event |
The current event object |