Skip to content

@vttforge/core / PackageSocket

Interface: PackageSocket ​

What registerSocket hands back.

Properties ​

channel ​

readonly channel: string

The channel Foundry routes on: module.<id> or system.<id>.

Methods ​

askGm() ​

askGm<T>(name, payload?, options?): Promise<T>

Ask the GM's client to run a request, and wait for its answer.

Type Parameters ​

T ​

T = unknown

Parameters ​

name ​

string

payload? ​

unknown

options? ​

AskGmOptions

Returns ​

Promise<T>


emit() ​

emit(name, payload?, options?): Promise<void>

Send a one-way message. Runs the handler here too, unless told not to.

Parameters ​

name ​

string

payload? ​

unknown

options? ​

EmitOptions

Returns ​

Promise<void>


isGmOnline() ​

isGmOnline(): boolean

Is a Gamemaster connected right now?

Returns ​

boolean

MIT licensed.