Document capabilities
Engine-owned capability slices generated from the current core registry.
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.
| Field | Shape |
|---|---|
prototypeToken | object |
#annotations
Writes use patch with GM write only.
| Field | Shape |
|---|---|
gmNotes | string |
#combat
Writes use sceneState with ordinary permission checks.
| Field | Shape |
|---|---|
combatants | array of object |
open | boolean |
round | number |
turn | number |
v | 1 |
#drawings
Writes use sceneEntries with ordinary permission checks. It contributes the drawing scene layer.
| Field | Shape |
|---|---|
entries | array of object |
v | 1 |
#effects
Writes use patch with ordinary permission checks.
| Field | Shape |
|---|---|
effects | array of object |
v | 1 |
#fog
Writes use sceneState with ordinary permission checks. It contributes the fog scene layer.
| Field | Shape |
|---|---|
base | hidden or revealed |
regions | array of object |
v | 1 |
#foldered
Writes use patch with ordinary permission checks.
| Field | Shape |
|---|---|
folderId | string or null |
#lights
Writes use sceneState with ordinary permission checks. It contributes the light scene layer.
| Field | Shape |
|---|---|
lights | array of object |
v | 1 |
#linkable
Writes use patch with ordinary permission checks.
| Field | Shape |
|---|---|
relations | array of object |
#pageable
Writes use patch with ordinary permission checks.
| Field | Shape |
|---|---|
pages | array of one of several defined shapes |
#placeable
Writes use patch with ordinary permission checks. It contributes the token scene layer.
| Field | Shape |
|---|---|
actorId | string or null |
art | string or null |
authoringVisible | boolean (optional) |
layer | background-tile or token or drawing or note |
locked | boolean |
noteDocId | string or null |
order | string |
rotation | number |
sceneId | string or null |
size | number |
x | number |
y | number |
#sceneEnvironment
Writes use sceneState with GM write only. It contributes the environment scene layer.
| Field | Shape |
|---|---|
ambientColor | string |
ambientIntensity | number |
shadows | object |
sunAzimuth | number |
sunColor | string |
sunElevation | number |
sunIntensity | number |
v | 1 |
#sceneLike
Writes use patch with GM write only.
| Field | Shape |
|---|---|
background | string or null |
fogExploration | fov or memory |
grid | object |
height | number |
width | number |
#sceneStructure
Writes use sceneEntries with GM write only. It contributes the structure scene layer.
| Field | Shape |
|---|---|
floors | array of object |
materials | array of object |
openings | array of one of several defined shapes |
props | array of object |
v | 1 |
walls | array of object |
#vision
Writes use patch with GM write only.
| Field | Shape |
|---|---|
angle | number |
detection | sight or blindsight or truesight |
enabled | boolean |
mode | basic or dark or blind |
range | number |
#walls
Writes use sceneState with ordinary permission checks. It contributes the walls scene layer.
| Field | Shape |
|---|---|
v | 1 |
walls | array of object |