@vttforge/types / ChatMessageLike

Interface: ChatMessageLike<System>

A chat message.

Extends

• DocumentMembers<System>

Type Parameters

System

System = Record<string, unknown>

Properties

alias

readonly alias: string

The speaker's display name.

---

author

readonly author: UserLike | null

---

blind

readonly blind: boolean

---

content

readonly content: string

---

documentName

readonly documentName: string

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

Inherited from

DocumentMembers.documentName

---

emote

readonly emote: boolean

---

flags

readonly flags: DocumentFlags

Inherited from

DocumentMembers.flags

---

flavor

readonly flavor: string

---

id

readonly id: string | null

Inherited from

DocumentMembers.id

---

img

readonly img: string | null

Inherited from

DocumentMembers.img

---

isAuthor

readonly isAuthor: boolean

---

isContentVisible

readonly isContentVisible: boolean

---

isOwner

readonly isOwner: boolean

Whether the current user owns this document.

Inherited from

DocumentMembers.isOwner

---

isRoll

readonly isRoll: boolean

---

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

---

rolls

readonly rolls: RollLike[]

---

sound

readonly sound: string | null

---

speaker

readonly speaker: ChatSpeakerData

---

speakerActor

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

---

style

readonly style: number

---

system

readonly system: System

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

Inherited from

DocumentMembers.system

---

timestamp

readonly timestamp: number

---

title

readonly title: string

---

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

---

visible

readonly visible: boolean

---

whisper

readonly whisper: string[]

Methods

applyMode()

applyMode(mode): void

Apply a CONFIG.ChatMessage.modes key to this message.

Parameters

mode

string

Returns

void

---

delete()

delete(operation?): Promise<ChatMessageLike<System> | undefined>

Parameters

operation?

Record<string, unknown>

Returns

Promise<ChatMessageLike<System> | undefined>

Inherited from

DocumentMembers.delete

---

export()

export(): string

Returns

string

---

getFlag()

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

Type Parameters

T

T = unknown

Parameters

scope

string

key

string

Returns

T | undefined

Inherited from

DocumentMembers.getFlag

---

getRollData()

getRollData(): Record<string, unknown>

Returns

Record<string, unknown>

---

renderHTML()

renderHTML(options?): Promise<HTMLElement>

Parameters

options?

canClose?

boolean

canDelete?

boolean

Returns

Promise<HTMLElement>

---

setFlag()

setFlag(scope, key, value): Promise<ChatMessageLike<System>>

Parameters

scope

string

key

string

value

unknown

Returns

Promise<ChatMessageLike<System>>

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<ChatMessageLike<System>>

Parameters

scope

string

key

string

Returns

Promise<ChatMessageLike<System>>

Inherited from

DocumentMembers.unsetFlag

---

update()

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

Parameters

data

Record<string, unknown>

operation?

Record<string, unknown>

Returns

Promise<ChatMessageLike<System> | undefined>

Inherited from

DocumentMembers.update