Package me.tamkungz.signals.bungee

Class SignalsBungeePlugin

java.lang.Object
net.md_5.bungee.api.plugin.Plugin
me.tamkungz.signals.bungee.SignalsBungeePlugin
public final class SignalsBungeePlugin extends net.md_5.bungee.api.plugin.Plugin
BungeeCord and Waterfall plugin entrypoint for proxies that want to load SignalsLib as a shared library.

Other plugins add depends: [SignalsLib] to their bungee.yml and use BungeeSignals.shared().

  • Constructor Summary

    Constructors
    Constructor
    Description
    SignalsBungeePlugin()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    me.tamkungz.signals.SignalBus
    bus()
    Returns the signal bus shared by every plugin.
    me.tamkungz.signals.connection.ConnectionGroup
    connections()
    Returns the group that is disconnected when SignalsLib disables.
    static SignalsBungeePlugin
    getInstance()
    Returns the loaded SignalsLib plugin.
    void
    onDisable()
     
    void
    onLoad()
     
    BungeeSignals
    signals()
    Returns the bridge shared by every plugin.
    <T extends me.tamkungz.signals.connection.Connection>
    T
    track(T connection)
    Tracks a connection so it is disconnected when SignalsLib disables.

    Methods inherited from class net.md_5.bungee.api.plugin.Plugin

    getDataFolder, getDescription, getExecutorService, getFile, getLogger, getProxy, getResourceAsStream, onEnable

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • SignalsBungeePlugin

      public SignalsBungeePlugin()

  • Method Details

    • onLoad

      public void onLoad()
      Overrides:
      onLoad in class net.md_5.bungee.api.plugin.Plugin

    • onDisable

      public void onDisable()
      Overrides:
      onDisable in class net.md_5.bungee.api.plugin.Plugin

    • getInstance

      public static SignalsBungeePlugin getInstance()
      Returns the loaded SignalsLib plugin.
      Returns:
      the plugin instance
      Throws:
      IllegalStateException - if SignalsLib is not loaded

    • signals

      public BungeeSignals signals()
      Returns the bridge shared by every plugin.
      Returns:
      the shared bridge

    • bus

      public me.tamkungz.signals.SignalBus bus()
      Returns the signal bus shared by every plugin.
      Returns:
      the shared bus

    • connections

      public me.tamkungz.signals.connection.ConnectionGroup connections()
      Returns the group that is disconnected when SignalsLib disables.
      Returns:
      the plugin's connection group

    • track

      public <T extends me.tamkungz.signals.connection.Connection> T track(T connection)
      Tracks a connection so it is disconnected when SignalsLib disables.
      Type Parameters:
      T - connection type
      Parameters:
      connection - connection to track
      Returns:
      the same connection