World Entry Nodes
Read and write the scene's world entries (the world information shown in the world state panel) and build generation options — writing styles and spices — that steer content generation.
8 nodes.
| Node | Registry path |
|---|---|
| Get World Entries | scene/worldstate/GetWorldEntries |
| Get World Entry | scene/worldstate/GetWorldEntry |
| Remove World Entry | scene/worldstate/RemoveWorldEntry |
| Save World Entry | scene/worldstate/SaveWorldEntry |
| Generation Options | scene/worldstate/templates/GenerationOptions |
| Spices | scene/worldstate/templates/Spices |
| Writing Style | scene/worldstate/templates/WritingStyle |
| Unpack World Entry | scene/worldstate/UnpackWorldEntry |
Get World Entries
scene/worldstate/GetWorldEntries
Gets world entries, optionally filtered by a list of ids
Ids are matched case-insensitively. If no ids are given, all world entries are returned. If raise_on_missing is enabled, an error is raised when any requested id is not found.
Inputs
| Input | Type | Description |
|---|---|---|
ids |
list |
(optional) The ids of the world entries to get |
Outputs
| Output | Type | Description |
|---|---|---|
world_entries |
dict |
Dictionary of world entries keyed by entry id |
Properties
| Property | Type | Default | Description |
|---|---|---|---|
ids |
list |
unset |
The ids of the world entries |
raise_on_missing |
bool |
False |
Whether to raise an error if a world entry is missing |
Get World Entry
scene/worldstate/GetWorldEntry
Gets a world entry by its id
Inputs
| Input | Type | Description |
|---|---|---|
entry_id |
str |
The id of the world entry |
Outputs
| Output | Type | Description |
|---|---|---|
world_entry |
world_entry |
The world entry object |
entry_id |
str |
The id of the world entry, passed through |
text |
str |
The text of the world entry |
shared |
bool |
Whether the entry is shared |
Properties
| Property | Type | Default | Description |
|---|---|---|---|
entry_id |
str |
unset |
The id of the world entry |
Remove World Entry
scene/worldstate/RemoveWorldEntry
Removes a world entry
Inputs
| Input | Type | Description |
|---|---|---|
state |
any |
|
entry_id |
str |
Outputs
| Output | Type | Description |
|---|---|---|
state |
any |
|
entry_id |
str |
Save World Entry
scene/worldstate/SaveWorldEntry
Saves the world entry
Inputs
| Input | Type | Description |
|---|---|---|
entry_id |
str |
(optional) The id of the world entry |
text |
str |
(optional) The text of the world entry |
meta |
dict |
(optional) The meta of the world entry |
Outputs
| Output | Type | Description |
|---|---|---|
entry_id |
str |
The id of the world entry |
text |
str |
The text of the world entry |
meta |
dict |
The meta of the world entry |
Properties
| Property | Type | Default | Description |
|---|---|---|---|
entry_id |
str |
unset |
The id of the world entry |
text |
text |
unset |
The text of the world entry |
meta |
dict |
{} |
The meta of the world entry |
create_pin |
bool |
False |
Whether to create a pin for the entry |
Generation Options
scene/worldstate/templates/GenerationOptions
Node that returns a GenerationOptions object
Inputs
| Input | Type | Description |
|---|---|---|
spices |
spices |
(optional) The spices to apply to the generation options (input-only) |
spice_level |
number |
(optional) The spice level to apply to the generation options |
writing_style |
writing_style |
(optional) The writing style to apply to the generation options |
Outputs
| Output | Type | Description |
|---|---|---|
generation_options |
generation_options |
The generation options |
Properties
| Property | Type | Default | Description |
|---|---|---|---|
spice_level |
number |
0.0 |
The spice level to apply to the generation options. Range: 0.0 – 1.0. |
writing_style |
writing_style |
"" |
The writing style to apply to the generation options |
Spices
scene/worldstate/templates/Spices
Node that returns a Spices object
Inputs
| Input | Type | Description |
|---|---|---|
spice_values |
list |
(optional) list of strings |
Outputs
| Output | Type | Description |
|---|---|---|
spices |
spices |
The Spices object built from the spice values |
Properties
| Property | Type | Default | Description |
|---|---|---|---|
spice_values |
list |
[] |
The list of spices |
Writing Style
scene/worldstate/templates/WritingStyle
Node that returns a WritingStyle object
Inputs
| Input | Type | Description |
|---|---|---|
instructions |
str |
(optional) Writing style instructions |
Outputs
| Output | Type | Description |
|---|---|---|
writing_style |
writing_style |
The writing style to apply to the generation options |
Properties
| Property | Type | Default | Description |
|---|---|---|---|
instructions |
text |
"" |
Writing style instructions |
Unpack World Entry
scene/worldstate/UnpackWorldEntry
Unpacks a world entry into its individual fields
Inputs
| Input | Type | Description |
|---|---|---|
world_entry |
world_entry |
The world entry object |
Outputs
| Output | Type | Description |
|---|---|---|
entry_id |
str |
The id of the world entry |
text |
str |
The text of the world entry |
meta |
dict |
The meta of the world entry |