@vttforge/core / MacroLike

Interface: MacroLike

A macro.

Extends

• DocumentMembers

Properties

author

readonly author: UserLike | null

---

canExecute

readonly canExecute: boolean

---

command

readonly command: string

---

documentName

readonly documentName: string

'Actor', 'Item', 'ActiveEffect', and so on.

Inherited from

DocumentMembers.documentName

---

flags

readonly flags: DocumentFlags

Inherited from

DocumentMembers.flags

---

id

readonly id: string | null

Inherited from

DocumentMembers.id

---

img

readonly img: string | null

Inherited from

DocumentMembers.img

---

isOwner

readonly isOwner: boolean

Whether the current user owns this document.

Inherited from

DocumentMembers.isOwner

---

name

readonly name: string

Inherited from

DocumentMembers.name

---

parent

readonly parent: DocumentMembers<Record<string, unknown>> | null

The document this one is embedded in, or null at the top level.

Inherited from

DocumentMembers.parent

---

scope

readonly scope: string

---

system

readonly system: System

The type data model instance. Its fields are the schema's fields.

Inherited from

DocumentMembers.system

---

type

readonly type: string

The subtype, as declared under documentTypes in the manifest.

Inherited from

DocumentMembers.type

---

uuid

readonly uuid: string

Inherited from

DocumentMembers.uuid

Methods

delete()

delete(operation?): Promise<MacroLike | undefined>

Parameters

operation?

Record<string, unknown>

Returns

Promise<MacroLike | undefined>

Inherited from

DocumentMembers.delete

---

execute()

execute(scope?): Promise<unknown>

Parameters

scope?

Record<string, unknown>

Returns

Promise<unknown>

---

getFlag()

getFlag<T>(scope, key): T | undefined

Type Parameters

T

T = unknown

Parameters

scope

string

key

string

Returns

T | undefined

Inherited from

DocumentMembers.getFlag

---

setFlag()

setFlag(scope, key, value): Promise<MacroLike>

Parameters

scope

string

key

string

value

unknown

Returns

Promise<MacroLike>

Inherited from

DocumentMembers.setFlag

---

toObject()

toObject(source?): Record<string, unknown>

A plain-object copy. source reads the stored data instead of the prepared data.

Parameters

source?

boolean

Returns

Record<string, unknown>

Inherited from

DocumentMembers.toObject

---

unsetFlag()

unsetFlag(scope, key): Promise<MacroLike>

Parameters

scope

string

key

string

Returns

Promise<MacroLike>

Inherited from

DocumentMembers.unsetFlag

---

update()

update(data, operation?): Promise<MacroLike | undefined>

Parameters

data

Record<string, unknown>

operation?

Record<string, unknown>

Returns

Promise<MacroLike | undefined>

Inherited from

DocumentMembers.update