Class SignalsVelocityPlugin

java.lang.Object
me.tamkungz.signals.velocity.SignalsVelocityPlugin
public final class SignalsVelocityPlugin extends Object
Velocity plugin entrypoint for proxies that want to load SignalsLib as a shared library.

The plugin id is signalslib; other plugins list it as a dependency and use VelocitySignals.shared(). Its velocity-plugin.json is written by hand instead of being generated from @Plugin, so the version always follows the build.

  • Constructor Details

    • SignalsVelocityPlugin

      @Inject public SignalsVelocityPlugin(com.velocitypowered.api.proxy.ProxyServer server, org.slf4j.Logger logger)
      Called by Velocity.
      Parameters:
      server - the proxy
      logger - logger of this plugin

  • Method Details

    • getInstance

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

    • onProxyShutdown

      public void onProxyShutdown(com.velocitypowered.api.event.proxy.ProxyShutdownEvent event)
      Cleans up when the proxy shuts down.
      Parameters:
      event - shutdown event

    • signals

      public VelocitySignals signals()

    • bus

      public me.tamkungz.signals.SignalBus bus()

    • connections

      public me.tamkungz.signals.connection.ConnectionGroup connections()

    • track

      public <T extends me.tamkungz.signals.connection.Connection> T track(T connection)