Package dev.itsharshxd.zentrix.api.scenario.hook

Interface HookHandle

All Superinterfaces:
AutoCloseable
public interface HookHandle extends AutoCloseable
A registered gameplay override, kept only so a scenario can drop it early.

Releasing is optional: every handle a scenario registers through its game context is released automatically when the scenario is deactivated or the game ends, which is what keeps an override scoped to one match and restores Zentrix's own behaviour afterwards.

Since:
1.6.0

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    close()
     
    boolean
    isActive()
    Whether the override is still installed.
    void
    release()
    Removes the override.

  • Method Details

    • release

      void release()
      Removes the override. Calling this more than once is harmless.

    • isActive

      boolean isActive()
      Whether the override is still installed.

    • close

      default void close()
      Specified by:
      close in interface AutoCloseable