@vttforge/types / CanvasApi

Interface: CanvasApi

The canvas global.

Properties

activeLayer

readonly activeLayer: unknown

---

colors

readonly colors: Record<string, unknown>

---

darknessLevel

readonly darknessLevel: number

---

dimensions

readonly dimensions: Record<string, number>

---

drawings

readonly drawings: unknown

---

edges

readonly edges: unknown

---

effects

readonly effects: unknown

---

grid

readonly grid: Record<string, unknown>

---

id

readonly id: string | null

---

initialized

readonly initialized: boolean

---

layers

readonly layers: Record<string, unknown>

---

level

readonly level: LevelLike | null

The Level being viewed. New in v14.

---

lighting

readonly lighting: unknown

---

masks

readonly masks: unknown

---

notes

readonly notes: unknown

---

ready

readonly ready: boolean

---

regions

readonly regions: object

templateMode

templateMode: boolean

placeRegion()

placeRegion(data, options?): Promise<DocumentMembers<Record<string, unknown>> | null>

Parameters

data

Record<string, unknown>

options?

create?

boolean

Returns

Promise<DocumentMembers<Record<string, unknown>> | null>

---

scene

readonly scene: SceneLike<Record<string, unknown>> | null

---

sounds

readonly sounds: unknown

---

tiles

readonly tiles: unknown

---

tokens

readonly tokens: object

controlled

readonly controlled: TokenObjectLike[]

placeables

readonly placeables: TokenObjectLike[]

get()

get(id): TokenObjectLike | undefined

Parameters

id

string

Returns

TokenObjectLike | undefined

---

walls

readonly walls: unknown

Methods

animatePan()

animatePan(position?): Promise<void>

Parameters

position?

Record<string, unknown>

Returns

Promise<void>

---

draw()

draw(scene?): Promise<CanvasApi>

Parameters

scene?

SceneLike<Record<string, unknown>>

Returns

Promise<CanvasApi>

---

pan()

pan(position?): void

Parameters

position?

scale?

number

x?

number

y?

number

Returns

void