Interface EventSignalSource

All Known Implementing Classes:
VelocitySignals
public interface EventSignalSource
Supplies the Signal that carries a Velocity event for a given post order.

The fluent EventSignalBuilder and the per-domain accessors depend on this interface only, which keeps them free of VelocitySignals itself.

  • Method Summary

    Modifier and Type
    Method
    Description
    default <T> EventSignalBuilder<T>
    on(Class<T> eventType)
    Starts a fluent configuration for an event type.
    default <T> me.tamkungz.signals.Signal<T>
    signal(Class<T> eventType)
    Returns the signal for an event type at PostOrder.NORMAL.
    <T> me.tamkungz.signals.Signal<T>
    signal(Class<T> eventType, com.velocitypowered.api.event.PostOrder order)
    Returns the signal for an event type with the given post order.

  • Method Details

    • signal

      <T> me.tamkungz.signals.Signal<T> signal(Class<T> eventType, com.velocitypowered.api.event.PostOrder order)
      Returns the signal for an event type with the given post order.
      Type Parameters:
      T - event type
      Parameters:
      eventType - Velocity event type
      order - order in which the underlying Velocity handler runs relative to other handlers
      Returns:
      the signal for that combination

    • signal

      default <T> me.tamkungz.signals.Signal<T> signal(Class<T> eventType)
      Returns the signal for an event type at PostOrder.NORMAL.
      Type Parameters:
      T - event type
      Parameters:
      eventType - Velocity event type
      Returns:
      the default signal for the event type

    • on

      default <T> EventSignalBuilder<T> on(Class<T> eventType)
      Starts a fluent configuration for an event type.
      Type Parameters:
      T - event type
      Parameters:
      eventType - Velocity event type
      Returns:
      a builder for the post order option