Class: SplashAPI
Defined in: api.ts:64
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new SplashAPI():
SplashAPI
Returns
Section titled “Returns”SplashAPI
Accessors
Section titled “Accessors”registeredActions
Section titled “registeredActions”Get Signature
Section titled “Get Signature”get registeredActions():
RegisteredType[]
Defined in: api.ts:191
Returns
Section titled “Returns”registeredAnimations
Section titled “registeredAnimations”Get Signature
Section titled “Get Signature”get registeredAnimations():
RegisteredType[]
Defined in: api.ts:183
Returns
Section titled “Returns”registeredEffects
Section titled “registeredEffects”Get Signature
Section titled “Get Signature”get registeredEffects():
RegisteredType[]
Defined in: api.ts:187
Returns
Section titled “Returns”registeredTriggers
Section titled “registeredTriggers”Get Signature
Section titled “Get Signature”get registeredTriggers():
TriggerDefinition[]
Defined in: api.ts:200
Returns
Section titled “Returns”TriggerDefinition[]
Methods
Section titled “Methods”applySplashState()
Section titled “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
Section titled “Parameters”string
snapshot
Section titled “snapshot”RuntimeSnapshot
Returns
Section titled “Returns”Promise<void>
bindingsForSplash()
Section titled “bindingsForSplash()”bindingsForSplash(
splashUuid):TriggerBinding[]
Defined in: api.ts:208
Parameters
Section titled “Parameters”splashUuid
Section titled “splashUuid”string
Returns
Section titled “Returns”TriggerBinding[]
buildAnimation()
Section titled “buildAnimation()”buildAnimation(
animation,sprite,app):Promise<void>
Defined in: api.ts:110
Parameters
Section titled “Parameters”animation
Section titled “animation”any
sprite
Section titled “sprite”DisplayObject
Application
Returns
Section titled “Returns”Promise<void>
buildEffect()
Section titled “buildEffect()”buildEffect(
app,effect):Promise<any>
Defined in: api.ts:155
Parameters
Section titled “Parameters”Application
effect
Section titled “effect”any
Returns
Section titled “Returns”Promise<any>
buildSprite()
Section titled “buildSprite()”buildSprite(
sprite,state,context):Promise<any>
Defined in: api.ts:132
Parameters
Section titled “Parameters”sprite
Section titled “sprite”any
InitializedData
context
Section titled “context”SpriteContext
Returns
Section titled “Returns”Promise<any>
close()
Section titled “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
Section titled “Parameters”__namedParameters?
Section titled “__namedParameters?”global?
Section titled “global?”boolean = false
Returns
Section titled “Returns”Promise<void>
closeSpectator()
Section titled “closeSpectator()”closeSpectator(
uuid):Promise<void>
Defined in: api.ts:307
Close a spectator mirror opened with openSpectator.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<void>
getSplashState()
Section titled “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
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<RuntimeSnapshot | null>
getTrigger()
Section titled “getTrigger()”getTrigger(
type):TriggerDefinition|undefined
Defined in: api.ts:204
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”TriggerDefinition | undefined
launch()
Section titled “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
Section titled “Parameters”string
__namedParameters?
Section titled “__namedParameters?”global?
Section titled “global?”boolean = false
targetUser?
Section titled “targetUser?”string
Returns
Section titled “Returns”Promise<void>
openHandout()
Section titled “openHandout()”openHandout(
uuid):Promise<void>
Defined in: api.ts:261
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<void>
openSpectator()
Section titled “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
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<void>
processAction()
Section titled “processAction()”processAction(
action):Promise<void>
Defined in: api.ts:125
Parameters
Section titled “Parameters”action
Section titled “action”any
Returns
Section titled “Returns”Promise<void>
registerAction()
Section titled “registerAction()”registerAction<
A>(type,name,processor,meta?):void
Defined in: api.ts:90
Type Parameters
Section titled “Type Parameters”A extends any
Parameters
Section titled “Parameters”A["type"]
string
processor
Section titled “processor”EditorMeta = {}
Returns
Section titled “Returns”void
registerAnimation()
Section titled “registerAnimation()”registerAnimation<
A>(type,name,builder,meta?):void
Defined in: api.ts:79
Type Parameters
Section titled “Type Parameters”A extends any
Parameters
Section titled “Parameters”A["type"]
string
builder
Section titled “builder”EditorMeta = {}
Returns
Section titled “Returns”void
registerEffect()
Section titled “registerEffect()”registerEffect<
E>(type,name,builder,meta?):void
Defined in: api.ts:144
Type Parameters
Section titled “Type Parameters”E extends any
Parameters
Section titled “Parameters”E["type"]
string
builder
Section titled “builder”EditorMeta = {}
Returns
Section titled “Returns”void
registerSprite()
Section titled “registerSprite()”registerSprite<
S>(type,name,builder):void
Defined in: api.ts:101
Type Parameters
Section titled “Type Parameters”S extends any
Parameters
Section titled “Parameters”S["type"]
string
builder
Section titled “builder”Returns
Section titled “Returns”void
registerTrigger()
Section titled “registerTrigger()”registerTrigger(
type,label,options):void
Defined in: api.ts:196
First-party triggers (door, region) register through this same API.
Parameters
Section titled “Parameters”string
string
options
Section titled “options”TriggerOptions
Returns
Section titled “Returns”void
show()
Section titled “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
Section titled “Parameters”string
__namedParameters?
Section titled “__namedParameters?”global?
Section titled “global?”boolean = false
layer?
Section titled “layer?”SplashLayer = 'full'
targetUser?
Section titled “targetUser?”string
Returns
Section titled “Returns”Promise<void>
getInstance()
Section titled “getInstance()”
staticgetInstance():SplashAPI
Defined in: api.ts:326
Returns
Section titled “Returns”SplashAPI