Docssdk 0.0.0Aether homeOpen Aether

Document capabilities

Engine-owned capability slices generated from the current core registry.

3 minute read

These are engine-owned facets in a document's caps bag. A system composes them by id; game data stays in system. The field lists, write paths, permission flags and renderer hints below come from packages/core/src/capability.ts.

#actor

Writes use patch with ordinary permission checks.

FieldShape
prototypeTokenobject

#annotations

Writes use patch with GM write only.

FieldShape
gmNotesstring

#combat

Writes use sceneState with ordinary permission checks.

FieldShape
combatantsarray of object
openboolean
roundnumber
turnnumber
v1

#drawings

Writes use sceneEntries with ordinary permission checks. It contributes the drawing scene layer.

FieldShape
entriesarray of object
v1

#effects

Writes use patch with ordinary permission checks.

FieldShape
effectsarray of object
v1

#fog

Writes use sceneState with ordinary permission checks. It contributes the fog scene layer.

FieldShape
basehidden or revealed
regionsarray of object
v1

#foldered

Writes use patch with ordinary permission checks.

FieldShape
folderIdstring or null

#lights

Writes use sceneState with ordinary permission checks. It contributes the light scene layer.

FieldShape
lightsarray of object
v1

#linkable

Writes use patch with ordinary permission checks.

FieldShape
relationsarray of object

#pageable

Writes use patch with ordinary permission checks.

FieldShape
pagesarray of one of several defined shapes

#placeable

Writes use patch with ordinary permission checks. It contributes the token scene layer.

FieldShape
actorIdstring or null
artstring or null
authoringVisibleboolean (optional)
layerbackground-tile or token or drawing or note
lockedboolean
noteDocIdstring or null
orderstring
rotationnumber
sceneIdstring or null
sizenumber
xnumber
ynumber

#sceneEnvironment

Writes use sceneState with GM write only. It contributes the environment scene layer.

FieldShape
ambientColorstring
ambientIntensitynumber
shadowsobject
sunAzimuthnumber
sunColorstring
sunElevationnumber
sunIntensitynumber
v1

#sceneLike

Writes use patch with GM write only.

FieldShape
backgroundstring or null
fogExplorationfov or memory
gridobject
heightnumber
widthnumber

#sceneStructure

Writes use sceneEntries with GM write only. It contributes the structure scene layer.

FieldShape
floorsarray of object
materialsarray of object
openingsarray of one of several defined shapes
propsarray of object
v1
wallsarray of object

#vision

Writes use patch with GM write only.

FieldShape
anglenumber
detectionsight or blindsight or truesight
enabledboolean
modebasic or dark or blind
rangenumber

#walls

Writes use sceneState with ordinary permission checks. It contributes the walls scene layer.

FieldShape
v1
wallsarray of object
Was this page helpful?