@vttforge/types / TokenObjectLike

Interface: TokenObjectLike

The drawn token on the canvas, not the document.

Properties

actor

readonly actor: ActorLike<Record<string, unknown>, ItemLike<Record<string, unknown>>> | null

---

bounds

readonly bounds: object

height

height: number

width

width: number

x

x: number

y

y: number

---

center

readonly center: object

x

x: number

y

y: number

---

combatant

readonly combatant: CombatantLike<Record<string, unknown>> | null

---

controlled

readonly controlled: boolean

---

document

readonly document: TokenDocumentLike

---

h

readonly h: number

---

hover

readonly hover: boolean

---

inCombat

readonly inCombat: boolean

---

isTargeted

readonly isTargeted: boolean

---

isVisible

readonly isVisible: boolean

---

name

readonly name: string

---

w

readonly w: number

Methods

control()

control(options?): boolean

Parameters

options?

Record<string, unknown>

Returns

boolean

---

release()

release(options?): boolean

Parameters

options?

Record<string, unknown>

Returns

boolean

---

setTarget()

setTarget(targeted?, options?): void

Parameters

targeted?

boolean

options?

Record<string, unknown>

Returns

void