Skip to main content

Folder Element

Folders group related scenes and groups (nested folders) of related scenes.

Management

Add Folder

  1. From the World Outline, select the world or a folder element.
  2. Click the add element button > folder.

Alternatively, right-click a folder element and click add folder to... from the context menu.

Select Folder

  1. From the World Outline, click the desired folder to select.

Rename Folder

  1. From the World Outline, right-click the desired folder and click rename... from the context menu.
  2. Press return or click outside the element to save.

Alternatively, select the desired folder and rename from the element properties panel.

Remove Folder

  1. From the World Outline, right-click the desired folder and click remove... from the context menu.
caution

Removing a folder will permanently remove all nested folder and scene components.

Properties

When a Folder element is selected, the following properties are editable from the element properties panel:

Selected Folder

Schema

children

Ordered array of element child references represented as tuples with child element type at index 0 and child element UUID at index 1.

The folder element supports unique FOLDER and SCENE element child references.

Property Type

Array<['FOLDER' | 'SCENE', string]>

JSON Example

"children": [
["SCENE", "ca122de2-5736-43cc-86fd-5f23c575e7a1"],
["FOLDER", "58ee805c-2f58-4614-bfbc-d7d123272517"]
]

id

Folder UUID.

Property Type

string

JSON Example

"id": "58ee805c-2f58-4624-bfbc-c7d123272517"


parent

Tuple referencing parent element with parent element type at index 0 and parent element ID at index 1.

The folder element supports the GAME or a unique FOLDER element parent reference.

info

If the parent reference is of element type GAME, the element ID is null.

Property Type

['GAME' | 'FOLDER', string | null]

JSON Example

"parent": ["GAME", null]

"parent": ["FOLDER", "58ee805c-2f58-4624-bfbc-c7d123272517"]


tags

Property Type

string[]

JSON Example

"tags": ["city", "market"]


title

Folder title.

Property Type

string

JSON Example

"title": "NPCs"


updated

Last time folder element changed represented as the milliseconds elapsed since the UNIX epoch.

Property Type

number

JSON Example

"updated": 1636121968781