Hooks

Allows events to be passed between plugins and the core app, as well as allowing plugins to augment or replace certain behaviour.

When extending BasePlugin, these functions can be accessed via this.hooks.*

When extending BaseComponent, these functions can be accessed via this.plugin.hooks.*

Functions

addHandler(name: string, callback: Function) : void

Adds a hook handler.

function onKeyDown(evt) {
  console.log('key pressed', evt.code)
}
//
this.hooks.addHandler('controls.key.down', onKeyDown)

removeHandler(name: string, callback: Function) : void

Removes a hook handler.

function onKeyDown(evt) {
  console.log('key pressed', evt.code)
}
//
this.hooks.removeHandler('controls.key.down', onKeyDown)

trigger(name: string, data: any) : Promise<any>

Triggers a hook and returns the first truthy value. Note that listeners are able to modify the contents of the data object parameter.

const value = await this.hooks.trigger('my-custom-hook', { color: '#FFFFFF' })

triggerAll(name: string, data: any) : Promise<any[]>

Triggers a hook and returns all truthy values. Note that listeners are able to modify the contents of the data object parameter.

const values = await this.hooks.triggerAll('my-custom-hook', { color: '#FFFFFF' })

General Hooks

The following general hooks are exposed from the core app and available to use in any plugins or components.

Media Playback Hooks

A function to invoke Media Playback UI and a set of hooks exist to expose features within Vatom's own Media Share plugin.

The Media Playback plugin includes a component that has the ability to present UI allowing the user to select a media source. It can be invoked with the media-source-picker component action.

In addition, the following Media Playback hooks are supported: