Skip to main content

Item

The abstract interface for all Items.

TYPE
object

Properties

NAMETYPEDESCRIPTION
idstringThe ID of this item (read only)
typestringThe type of item
namestringThe name of the item
visiblebooleanIs this item visible
lockedbooleanIs this item locked
createdUserIdstringThe user ID of the player who created this item
zIndexnumberThe depth order of this item compared to other items on this layer
lastModifiedstringWhen this item was last modified (read only)
lastModifiedUserIdstringThe user ID of the player who last modified this item (read only)
positionVector2The position of this item
rotationnumberThe rotation of this item in degrees
scaleVector2The scale of this item
metadataMetadataCustom metadata for this item
layerLayerThe layer that this item is on
attachedTostringThe optional ID of the item this is attached to
disableHitbooleanAn optional boolean to disable the hit detection for this item
disableAutoZIndexbooleanAn optional boolean to disable the auto z-index update for this item
disableAttachmentBehaviorAttachmentBehavior[]An optional array of attachment behaviors to disable
descriptionstringAn optional description used by assistive technology

Type Definitions

Layer

TYPEvalues
string"MAP" | "GRID" | "DRAWING" | "PROP" | "MOUNT" | "CHARACTER" | "ATTACHMENT" | "NOTE" | "TEXT" | "RULER" | "FOG" | "POINTER" | "CONTROL" | "POPOVER"

AttachmentBehavior

TYPEvalues
string"VISIBLE" | "SCALE" | "ROTATION" | "POSITION" | "DELETE" | "LOCKED" | "COPY"