Skip to content

@vttforge/core / SystemHandle

Interface: SystemHandle ​

The system this world runs on.

Extends ​

Properties ​

active ​

readonly active: boolean

Installed and switched on in this world. Always true for the system.

Inherited from ​

PackageHandle.active


api? ​

optional api?: unknown

Whatever the package chose to expose. Yours to narrow.

Inherited from ​

PackageHandle.api


compatibility ​

readonly compatibility: object

maximum? ​

optional maximum?: string

minimum? ​

optional minimum?: string

verified? ​

optional verified?: string

Inherited from ​

PackageHandle.compatibility


documentTypes ​

readonly documentTypes: Record<string, Record<string, unknown>>


flags ​

readonly flags: Record<string, unknown>

Inherited from ​

PackageHandle.flags


grid ​

readonly grid: object

diagonals ​

diagonals: number

distance ​

distance: number

type ​

type: number

units ​

units: string


id ​

readonly id: string

Inherited from ​

PackageHandle.id


socket ​

readonly socket: boolean

The manifest's "socket" flag. Without it the channel is never opened.

Inherited from ​

PackageHandle.socket


title ​

readonly title: string

Inherited from ​

PackageHandle.title


version ​

readonly version: string

Inherited from ​

PackageHandle.version

MIT licensed.