events

HHM events, the event name will be passed along with each event in addition to the event data listed as "Properties" below.

Description

HHM events, the event name will be passed along with each event in addition to the event data listed as "Properties" below.

Properties
Name Type Description
eventName string

Name of the event.

Details

Members


<static> EVENT_HANDLER_SET

Triggered when an event handler was set.

Description

Triggered when an event handler was set.

Properties
Name Type Description
plugin HhmRoomObject

Associated plugin.

handlerName string

Name of the event handler.

handler *

Handler function or object.

Details

<static> LOCAL_EVENT

Triggered before a local event is dispatched.

Description

Triggered before a local event is dispatched.

Local events are only executed on one plugin. Currently known local event types:

  • roomLink
  • enable
  • disable
  • configSet
Properties
Name Type Description
plugin HhmRoomObject

Associated plugin.

localEventName string

Name of the local event, see the list above.

localEventArgs Array

Arguments to the local event, if any.

Details

<static> OTHER

Any other event that does not (yet) have an event type.

Description

Any other event that does not (yet) have an event type.

Properties
Name Type Description
eventArgs Array

Arguments to the event, if any.

Details

<static> PLUGIN_DISABLED

Triggered after a plugin was disabled.

Description

Triggered after a plugin was disabled.

Properties
Name Type Description
plugin HhmRoomObject

The disabled plugin.

Details

<static> PLUGIN_ENABLED

Triggered after a plugin was enabled.

Description

Triggered after a plugin was enabled.

Properties
Name Type Description
plugin HhmRoomObject

The enabled plugin.

Details

<static> BEFORE_PLUGIN_LOADED

Triggered before a plugin is loaded.

Description

Triggered before a plugin is loaded.

Triggered after the onRoomLink function for the given plugin has been called but before the plugin has been marked as loaded.

Properties
Name Type Description
plugin HhmRoomObject

The loaded plugin.

Details

<static> PLUGIN_LOADED

Triggered after a plugin was loaded.

Description

Triggered after a plugin was loaded.

Triggered after the onRoomLink function for the given plugin has been called and the plugin has been marked as loaded.

Properties
Name Type Description
plugin HhmRoomObject

The loaded plugin.

Details

<static> PLUGIN_REMOVED

Triggered after a plugin was removed.

Description

Triggered after a plugin was removed.

Properties
Name Type Description
plugin HhmRoomObject

The removed plugin.

Details

<static> PROPERTY_SET

Triggered after a plugin property was set.

Description

Triggered after a plugin property was set.

Properties
Name Type Description
plugin HhmRoomObject

Associated plugin.

propertyName string

Name of the property that was set.

propertyValue *

Value the property was set to.

propertyValueOld *

Previous value of the property or undefined.

Details

<static> PROPERTY_UNSET

Triggered after a plugin property was unset.

Description

Triggered after a plugin property was unset.

Properties
Name Type Description
plugin HhmRoomObject

Associated plugin.

propertyName string

Name of the property that was unset.

propertyValue *

Value of the property that was unset.

Details