@vttforge/types / TokenObjectLike

Interface: TokenObjectLike

What every object placed on the canvas carries.

A token adds to it: see TokenObjectLike. The others have no members of their own here yet, because no consumer has asked for one.

Extends

• PlaceableObjectLike

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

Inherited from

PlaceableObjectLike.bounds

---

center

readonly center: object

The point the object is centred on, in scene coordinates.

x

x: number

y

y: number

Inherited from

PlaceableObjectLike.center

---

combatant

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

---

controlled

readonly controlled: boolean

Inherited from

PlaceableObjectLike.controlled

---

document

readonly document: TokenDocumentLike

Overrides

PlaceableObjectLike.document

---

h

readonly h: number

---

hover

readonly hover: boolean

Inherited from

PlaceableObjectLike.hover

---

id

readonly id: string

Inherited from

PlaceableObjectLike.id

---

inCombat

readonly inCombat: boolean

---

isTargeted

readonly isTargeted: boolean

---

isVisible

readonly isVisible: boolean

Inherited from

PlaceableObjectLike.isVisible

---

name

readonly name: string

---

w

readonly w: number

Methods

control()

control(options?): boolean

Parameters

options?

Record<string, unknown>

Returns

boolean

Inherited from

PlaceableObjectLike.control

---

release()

release(options?): boolean

Parameters

options?

Record<string, unknown>

Returns

boolean

Inherited from

PlaceableObjectLike.release

---

setTarget()

setTarget(targeted?, options?): void

Parameters

targeted?

boolean

options?

Record<string, unknown>

Returns

void