Class: SplashAPI

Defined in: api.ts:64

Constructors

Constructor

new SplashAPI(): SplashAPI

Returns

SplashAPI

Accessors

registeredActions

Get Signature

get registeredActions(): RegisteredType[]

Defined in: api.ts:191

Returns

RegisteredType[]

---

registeredAnimations

Get Signature

get registeredAnimations(): RegisteredType[]

Defined in: api.ts:183

Returns

RegisteredType[]

---

registeredEffects

Get Signature

get registeredEffects(): RegisteredType[]

Defined in: api.ts:187

Returns

RegisteredType[]

---

registeredTriggers

Get Signature

get registeredTriggers(): TriggerDefinition[]

Defined in: api.ts:200

Returns

TriggerDefinition[]

Methods

applySplashState()

applySplashState(uuid, snapshot): Promise<void>

Defined in: api.ts:279

Apply a runtime snapshot to an open splash on this client, mirroring another client's state.

Parameters

uuid

string

snapshot

RuntimeSnapshot

Returns

Promise<void>

---

bindingsForSplash()

bindingsForSplash(splashUuid): TriggerBinding[]

Defined in: api.ts:208

Parameters

splashUuid

string

Returns

TriggerBinding[]

---

buildAnimation()

buildAnimation(animation, sprite, app): Promise<void>

Defined in: api.ts:110

Parameters

animation

any

sprite

DisplayObject

app

Application

Returns

Promise<void>

---

buildEffect()

buildEffect(app, effect): Promise<any>

Defined in: api.ts:155

Parameters

app

Application

effect

any

Returns

Promise<any>

---

buildSprite()

buildSprite(sprite, state, context): Promise<any>

Defined in: api.ts:132

Parameters

sprite

any

state

InitializedData

context

SpriteContext

Returns

Promise<any>

---

close()

close(__namedParameters?): Promise<void>

Defined in: api.ts:315

Close the active splash locally; global (GM only) kills it for the whole table.

Parameters

__namedParameters?

global?

boolean = false

Returns

Promise<void>

---

closeSpectator()

closeSpectator(uuid): Promise<void>

Defined in: api.ts:307

Close a spectator mirror opened with openSpectator.

Parameters

uuid

string

Returns

Promise<void>

---

getSplashState()

getSplashState(uuid): Promise<RuntimeSnapshot | null>

Defined in: api.ts:273

The current runtime snapshot of an open splash on this client, or null if it isn't open.

Parameters

uuid

string

Returns

Promise<RuntimeSnapshot | null>

---

getTrigger()

getTrigger(type): TriggerDefinition | undefined

Defined in: api.ts:204

Parameters

type

string

Returns

TriggerDefinition | undefined

---

launch()

launch(uuid, __namedParameters?): Promise<void>

Defined in: api.ts:242

Launch using the splash's stored layer. handout opens a windowed app; scene/hud/full open a fullscreen overlay.

Parameters

uuid

string

__namedParameters?

global?

boolean = false

targetUser?

string

Returns

Promise<void>

---

openHandout()

openHandout(uuid): Promise<void>

Defined in: api.ts:261

Parameters

uuid

string

Returns

Promise<void>

---

openSpectator()

openSpectator(uuid): Promise<void>

Defined in: api.ts:285

Open a splash on this client as a passive spectator mirror: no input, no presence, driven by applySplashState.

Parameters

uuid

string

Returns

Promise<void>

---

processAction()

processAction(action): Promise<void>

Defined in: api.ts:125

Parameters

action

any

Returns

Promise<void>

---

registerAction()

registerAction<A>(type, name, processor, meta?): void

Defined in: api.ts:90

Type Parameters

A

A extends any

Parameters

type

A["type"]

name

string

processor

ActionProcessor<A>

meta?

EditorMeta = {}

Returns

void

---

registerAnimation()

registerAnimation<A>(type, name, builder, meta?): void

Defined in: api.ts:79

Type Parameters

A

A extends any

Parameters

type

A["type"]

name

string

builder

AnimationBuilder<A>

meta?

EditorMeta = {}

Returns

void

---

registerEffect()

registerEffect<E>(type, name, builder, meta?): void

Defined in: api.ts:144

Type Parameters

E

E extends any

Parameters

type

E["type"]

name

string

builder

EffectBuilder<E>

meta?

EditorMeta = {}

Returns

void

---

registerSprite()

registerSprite<S>(type, name, builder): void

Defined in: api.ts:101

Type Parameters

S

S extends any

Parameters

type

S["type"]

name

string

builder

SpriteBuilder<S>

Returns

void

---

registerTrigger()

registerTrigger(type, label, options): void

Defined in: api.ts:196

First-party triggers (door, region) register through this same API.

Parameters

type

string

label

string

options

TriggerOptions

Returns

void

---

show()

show(uuid, __namedParameters?): Promise<void>

Defined in: api.ts:213

Show a splash at a layer. global (GM) shows it table-wide and persists; targetUser shows it transiently to one player; otherwise local.

Parameters

uuid

string

__namedParameters?

global?

boolean = false

layer?

SplashLayer = 'full'

targetUser?

string

Returns

Promise<void>

---

getInstance()

static getInstance(): SplashAPI

Defined in: api.ts:326

Returns

SplashAPI