@vttforge/types / PlaceableObjectLike

Interface: PlaceableObjectLike

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.

Extended by

• TokenObjectLike

Properties

bounds

readonly bounds: object

height

height: number

width

width: number

x

x: number

y

y: number

---

center

readonly center: object

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

x

x: number

y

y: number

---

controlled

readonly controlled: boolean

---

document

readonly document: DocumentMembers

---

hover

readonly hover: boolean

---

id

readonly id: string

---

isVisible

readonly isVisible: boolean

Methods

control()

control(options?): boolean

Parameters

options?

Record<string, unknown>

Returns

boolean

---

release()

release(options?): boolean

Parameters

options?

Record<string, unknown>

Returns

boolean