Skip to content
Void Monster Docs

Type to search guides and API reference.

    Splash/Developer docs

    Interface: SplashApi

    Public 1.2.0API 1.2.0

    @faeyumbrea/splash-api-types

    @faeyumbrea/splash-api-types / SplashApi

    Defined in: public-api.d.ts:122

    Supported runtime API exposed by the active splash or splash-premium package.

    Properties

    Section titled “Properties”

    applySplashState

    Section titled “applySplashState”

    applySplashState: (uuid, snapshot) => Promise<void>

    Defined in: public-api.d.ts:147

    Parameters

    Section titled “Parameters”
    uuid
    Section titled “uuid”

    string

    snapshot
    Section titled “snapshot”

    RuntimeSnapshot

    Returns

    Section titled “Returns”

    Promise<void>

    bindingsForSplash

    Section titled “bindingsForSplash”

    bindingsForSplash: (splashUuid) => TriggerBinding[]

    Defined in: public-api.d.ts:134

    Parameters

    Section titled “Parameters”
    splashUuid
    Section titled “splashUuid”

    string

    Returns

    Section titled “Returns”

    TriggerBinding[]

    close

    Section titled “close”

    close: (options?) => Promise<void>

    Defined in: public-api.d.ts:150

    Parameters

    Section titled “Parameters”
    options?
    Section titled “options?”
    global?
    Section titled “global?”

    boolean

    Returns

    Section titled “Returns”

    Promise<void>

    closeSpectator

    Section titled “closeSpectator”

    closeSpectator: (uuid) => Promise<void>

    Defined in: public-api.d.ts:149

    Parameters

    Section titled “Parameters”
    uuid
    Section titled “uuid”

    string

    Returns

    Section titled “Returns”

    Promise<void>

    getSplashState

    Section titled “getSplashState”

    getSplashState: (uuid) => Promise<RuntimeSnapshot | null>

    Defined in: public-api.d.ts:146

    Parameters

    Section titled “Parameters”
    uuid
    Section titled “uuid”

    string

    Returns

    Section titled “Returns”

    Promise<RuntimeSnapshot | null>

    getTrigger

    Section titled “getTrigger”

    getTrigger: (type) => TriggerDefinition | undefined

    Defined in: public-api.d.ts:133

    Parameters

    Section titled “Parameters”
    type
    Section titled “type”

    string

    Returns

    Section titled “Returns”

    TriggerDefinition | undefined

    launch

    Section titled “launch”

    launch: (uuid, options?) => Promise<void>

    Defined in: public-api.d.ts:141

    Parameters

    Section titled “Parameters”
    uuid
    Section titled “uuid”

    string

    options?
    Section titled “options?”
    global?
    Section titled “global?”

    boolean

    targetUser?
    Section titled “targetUser?”

    string

    Returns

    Section titled “Returns”

    Promise<void>

    openHandout

    Section titled “openHandout”

    openHandout: (uuid) => Promise<void>

    Defined in: public-api.d.ts:145

    Parameters

    Section titled “Parameters”
    uuid
    Section titled “uuid”

    string

    Returns

    Section titled “Returns”

    Promise<void>

    openSpectator

    Section titled “openSpectator”

    openSpectator: (uuid) => Promise<void>

    Defined in: public-api.d.ts:148

    Parameters

    Section titled “Parameters”
    uuid
    Section titled “uuid”

    string

    Returns

    Section titled “Returns”

    Promise<void>

    registerAction

    Section titled “registerAction”

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

    Defined in: public-api.d.ts:124

    Type Parameters

    Section titled “Type Parameters”
    A
    Section titled “A”

    A extends SplashActionData

    Parameters

    Section titled “Parameters”
    type
    Section titled “type”

    A["type"]

    name
    Section titled “name”

    string

    processor
    Section titled “processor”

    ActionProcessor<A>

    meta?
    Section titled “meta?”

    EditorMeta

    Returns

    Section titled “Returns”

    void

    registerAnimation

    Section titled “registerAnimation”

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

    Defined in: public-api.d.ts:123

    Type Parameters

    Section titled “Type Parameters”
    A
    Section titled “A”

    A extends SplashAnimationData

    Parameters

    Section titled “Parameters”
    type
    Section titled “type”

    A["type"]

    name
    Section titled “name”

    string

    builder
    Section titled “builder”

    AnimationBuilder<A>

    meta?
    Section titled “meta?”

    EditorMeta

    Returns

    Section titled “Returns”

    void

    registeredActions

    Section titled “registeredActions”

    readonly registeredActions: RegisteredType[]

    Defined in: public-api.d.ts:131

    registeredAnimations

    Section titled “registeredAnimations”

    readonly registeredAnimations: RegisteredType[]

    Defined in: public-api.d.ts:129

    registeredEffects

    Section titled “registeredEffects”

    readonly registeredEffects: RegisteredType[]

    Defined in: public-api.d.ts:130

    registeredTriggers

    Section titled “registeredTriggers”

    readonly registeredTriggers: TriggerDefinition[]

    Defined in: public-api.d.ts:132

    registerEffect

    Section titled “registerEffect”

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

    Defined in: public-api.d.ts:126

    Type Parameters

    Section titled “Type Parameters”
    E
    Section titled “E”

    E extends SplashEffectData

    Parameters

    Section titled “Parameters”
    type
    Section titled “type”

    E["type"]

    name
    Section titled “name”

    string

    builder
    Section titled “builder”

    EffectBuilder<E>

    meta?
    Section titled “meta?”

    EditorMeta

    Returns

    Section titled “Returns”

    void

    registerSprite

    Section titled “registerSprite”

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

    Defined in: public-api.d.ts:125

    Type Parameters

    Section titled “Type Parameters”
    S
    Section titled “S”

    S extends SplashSpriteData

    Parameters

    Section titled “Parameters”
    type
    Section titled “type”

    S["type"]

    name
    Section titled “name”

    string

    builder
    Section titled “builder”

    SpriteBuilder<S>

    Returns

    Section titled “Returns”

    void

    registerTrigger

    Section titled “registerTrigger”

    registerTrigger: (type, label, options) => void

    Defined in: public-api.d.ts:128

    Register a trigger with a display label or i18n key; labels are localized when read.

    Parameters

    Section titled “Parameters”
    type
    Section titled “type”

    string

    label
    Section titled “label”

    string

    options
    Section titled “options”

    TriggerOptions

    Returns

    Section titled “Returns”

    void

    show

    Section titled “show”

    show: (uuid, options?) => Promise<void>

    Defined in: public-api.d.ts:136

    Show locally for an Observer; targeting another client requires Owner, and global launch requires a GM.

    Parameters

    Section titled “Parameters”
    uuid
    Section titled “uuid”

    string

    options?
    Section titled “options?”
    global?
    Section titled “global?”

    boolean

    layer?
    Section titled “layer?”

    SplashLayer

    targetUser?
    Section titled “targetUser?”

    string

    Returns

    Section titled “Returns”

    Promise<void>