Package me.tamkungz.signals.bukkit.event

Interface EventSignalSource

All Known Implementing Classes:
BukkitSignals
public interface EventSignalSource
Supplies the Signal that carries a Bukkit event for a given priority and cancellation mode.

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

  • Method Summary

    Modifier and Type
    Method
    Description
    default <T extends org.bukkit.event.Event>
    EventSignalBuilder<T>
    on(Class<T> eventType)
    Starts a fluent configuration for an event type.
    default <T extends org.bukkit.event.Event>
    me.tamkungz.signals.Signal<T>
    signal(Class<T> eventType)
    Returns the signal for an event type at EventPriority.NORMAL, including cancelled events.
    <T extends org.bukkit.event.Event>
    me.tamkungz.signals.Signal<T>
    signal(Class<T> eventType, org.bukkit.event.EventPriority priority, boolean ignoreCancelled)
    Returns the signal for an event type with the given options.

  • Method Details

    • signal

      <T extends org.bukkit.event.Event> me.tamkungz.signals.Signal<T> signal(Class<T> eventType, org.bukkit.event.EventPriority priority, boolean ignoreCancelled)
      Returns the signal for an event type with the given options.
      Type Parameters:
      T - event type
      Parameters:
      eventType - Bukkit event type
      priority - priority the underlying Bukkit listener runs at
      ignoreCancelled - whether cancelled events are skipped
      Returns:
      the signal for that combination

    • signal

      default <T extends org.bukkit.event.Event> me.tamkungz.signals.Signal<T> signal(Class<T> eventType)
      Returns the signal for an event type at EventPriority.NORMAL, including cancelled events.
      Type Parameters:
      T - event type
      Parameters:
      eventType - Bukkit event type
      Returns:
      the default signal for the event type

    • on

      default <T extends org.bukkit.event.Event> EventSignalBuilder<T> on(Class<T> eventType)
      Starts a fluent configuration for an event type.
      Type Parameters:
      T - event type
      Parameters:
      eventType - Bukkit event type
      Returns:
      a builder for priority and cancellation options