@vttforge/types / ChatMessageConstructor

Interface: ChatMessageConstructor

The ChatMessage class itself.

Methods

applyMode()

applyMode(chatData, mode?): string

Apply a mode to message data before it is created.

Parameters

chatData

Record<string, unknown>

mode?

string

Returns

string

---

create()

create(data, options?): Promise<ChatMessageLike<Record<string, unknown>> | undefined>

Parameters

data

Record<string, unknown>

options?

ToMessageOptions & Record<string, unknown>

Returns

Promise<ChatMessageLike<Record<string, unknown>> | undefined>

---

getSpeaker()

getSpeaker(options?): ChatSpeakerData

Parameters

options?

actor?

ActorLike<Record<string, unknown>, ItemLike<Record<string, unknown>>>

alias?

string

scene?

SceneLike<Record<string, unknown>>

token?

TokenDocumentLike<Record<string, unknown>>

Returns

ChatSpeakerData

---

getSpeakerActor()

getSpeakerActor(speaker): ActorLike<Record<string, unknown>, ItemLike<Record<string, unknown>>> | null

Parameters

speaker

ChatSpeakerData

Returns

ActorLike<Record<string, unknown>, ItemLike<Record<string, unknown>>> | null

---

getWhisperRecipients()

getWhisperRecipients(name): UserLike[]

Parameters

name

string

Returns

UserLike[]