CreateActiveListSubscriberConfig<T>

Properties

• debug Optional

  boolean

  Optionally whether or not you want to show debug logging.

  When debug is enabled whenever an event method is not provided but the event is fired, a console.warn message is logged. This allows you to easier detect missing methods during development.

  Defaults to false, meaning nothing will be logged to the console.

  Since 1.5.0

• onActivated

  Method which is called whenever an ACTIVATED event is fired from within the ActiveList.

  Since 1.5.0

  Signature

  callback(

  event : ActiveListActivatedEvent<T> ,

  activeList : ActiveList<T>

  ): void

  Parameters

  event: ActiveListActivatedEvent<T>

  The event that was fired.

  activeList: ActiveList<T>

  The ActiveList the event was fired from

• onActivatedMultiple

  Method which is called whenever an ACTIVATED_MULTIPLE event is fired from within the ActiveList.

  Since 1.5.0

  Signature

  callback(

  event : ActiveListActivatedMultipleEvent<T> ,

  activeList : ActiveList<T>

  ): void

  Parameters

  event: ActiveListActivatedMultipleEvent<T>

  The event that was fired.

  activeList: ActiveList<T>

  The ActiveList the event was fired from

• onAutoPlayPaused

  Method which is called whenever an AUTO_PLAY_PAUSED event is fired from within the ActiveList.

  Since 1.5.0

  Signature

  callback(

  event : ActiveListAutoPlayPausedEvent ,

  activeList : ActiveList<T>

  ): void

  Parameters

  event: ActiveListAutoPlayPausedEvent

  The event that was fired.

  activeList: ActiveList<T>

  The ActiveList the event was fired from

• onAutoPlayPlaying

  Method which is called whenever an AUTO_PLAY_PLAYING event is fired from within the ActiveList.

  Since 1.5.0

  Signature

  callback(

  event : ActiveListAutoPlayPlayingEvent ,

  activeList : ActiveList<T>

  ): void

  Parameters

  event: ActiveListAutoPlayPlayingEvent

  The event that was fired.

  activeList: ActiveList<T>

  The ActiveList the event was fired from

• onAutoPlayStopped

  Method which is called whenever an AUTO_PLAY_STOPPED event is fired from within the ActiveList.

  Since 1.5.0

  Signature

  callback(

  event : ActiveListAutoPlayStoppedEvent ,

  activeList : ActiveList<T>

  ): void

  Parameters

  event: ActiveListAutoPlayStoppedEvent

  The event that was fired.

  activeList: ActiveList<T>

  The ActiveList the event was fired from

• onCooldownEnded

  Method which is called whenever an COOLDOWN_ENDED event is fired from within the ActiveList.

  Since 1.5.0

  Signature

  callback(

  event : ActiveListCooldownEndedEvent ,

  activeList : ActiveList<T>

  ): void

  Parameters

  event: ActiveListCooldownEndedEvent

  The event that was fired.

  activeList: ActiveList<T>

  The ActiveList the event was fired from

• onCooldownStarted

  Method which is called whenever an COOLDOWN_STARTED event is fired from within the ActiveList.

  Since 1.5.0

  Signature

  callback(

  event : ActiveListCooldownStartedEvent ,

  activeList : ActiveList<T>

  ): void

  Parameters

  event: ActiveListCooldownStartedEvent

  The event that was fired.

  activeList: ActiveList<T>

  The ActiveList the event was fired from

• onDeactivated

  Method which is called whenever an DEACTIVATED event is fired from within the ActiveList.

  Since 1.5.0

  Signature

  callback(

  event : ActiveListDeactivatedEvent<T> ,

  activeList : ActiveList<T>

  ): void

  Parameters

  event: ActiveListDeactivatedEvent<T>

  The event that was fired.

  activeList: ActiveList<T>

  The ActiveList the event was fired from

• onDeactivatedMultiple

  Method which is called whenever an DEACTIVATED_MULTIPLE event is fired from within the ActiveList.

  Since 1.5.0

  Signature

  callback(

  event : ActiveListDeactivatedMultipleEvent<T> ,

  activeList : ActiveList<T>

  ): void

  Parameters

  event: ActiveListDeactivatedMultipleEvent<T>

  The event that was fired.

  activeList: ActiveList<T>

  The ActiveList the event was fired from

• onInitialized

  Method which is called whenever an INITIALIZED event is fired from within the ActiveList.

  Since 1.5.0

  Signature

  callback(

  event : ActiveListInitializedEvent<T> ,

  activeList : ActiveList<T>

  ): void

  Parameters

  event: ActiveListInitializedEvent<T>

  The event that was fired.

  activeList: ActiveList<T>

  The ActiveList the event was fired from

• onInserted

  Method which is called whenever an INSERTED event is fired from within the ActiveList.

  Since 1.5.0

  Signature

  callback(

  event : ActiveListInsertedEvent<T> ,

  activeList : ActiveList<T>

  ): void

  Parameters

  event: ActiveListInsertedEvent<T>

  The event that was fired.

  activeList: ActiveList<T>

  The ActiveList the event was fired from

• onMoved

  Method which is called whenever an MOVED event is fired from within the ActiveList.

  Since 1.5.0

  Signature

  callback(

  event : ActiveListMovedEvent<T> ,

  activeList : ActiveList<T>

  ): void

  Parameters

  event: ActiveListMovedEvent<T>

  The event that was fired.

  activeList: ActiveList<T>

  The ActiveList the event was fired from

• onRemoved

  Method which is called whenever an REMOVED event is fired from within the ActiveList.

  Since 1.5.0

  Signature

  callback(

  event : ActiveListRemovedEvent<T> ,

  activeList : ActiveList<T>

  ): void

  Parameters

  event: ActiveListRemovedEvent<T>

  The event that was fired.

  activeList: ActiveList<T>

  The ActiveList the event was fired from

• onRemovedMultiple

  Method which is called whenever an REMOVED_MULTIPLE event is fired from within the ActiveList.

  Since 1.5.0

  Signature

  callback(

  event : ActiveListRemovedMultipleEvent<T> ,

  activeList : ActiveList<T>

  ): void

  Parameters

  event: ActiveListRemovedMultipleEvent<T>

  The event that was fired.

  activeList: ActiveList<T>

  The ActiveList the event was fired from

• onSwapped

  Method which is called whenever an SWAPPED event is fired from within the ActiveList.

  Since 1.5.0

  Signature

  callback(

  event : ActiveListSwappedEvent<T> ,

  activeList : ActiveList<T>

  ): void

  Parameters

  event: ActiveListSwappedEvent<T>

  The event that was fired.

  activeList: ActiveList<T>

  The ActiveList the event was fired from