Skip to content

whisper

Jason Godesky edited this page Jul 19, 2026 · 1 revision

whisper is a wrapper that sends a whispered chat message to one or more players.

Parameters

options?: Partial<WhisperOptions>

An object to specify what to whisper.

options?.recipients: string[]

An array of the UUIDs of the users you would like to send the whisper to.

Default: [game.user.id], the current user.

options?.speaker: string

The alias to use for the message, communicating who sent the whisper.

Default: game.user.name, the current user’s name

options?.flavor: string

Optional. The flavor message to use for the chat message.

options?.content: string

Optional. The content of the message to send.

Examples

import { whisper } from '@revolutionarygamesco/common-foundryvtt'

await whisper({ content: 'Psst!' })

Clone this wiki locally