Package cz.jeme.bestium.api

Interface Bestium

@NonExtendable public interface Bestium
The core system for managing custom Minecraft entities.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final class 
    Bestium.InstanceHolder
    Holds all the internal singleton instances.

  • Method Summary

    Modifier and Type
    Method
    Description
    NamespacedKey
    createKey(String key)
    Constructs a NamespacedKey from the given string key value.
    static Bestium
    getBestium()
    Returns the Bestium plugin instance cast as Bestium.
    static EntityManager
    getEntityManager()
    Returns the Bestium entity manager instance, handling the initialization, lifecycle and other logic and helper methods for Bestium entities.
    static EntityInjector
    getInjector()
    Returns the main entity injector instance, which handles the registration and management of custom entities within Bestium.
    static JavaPlugin
    getPlugin()
    Returns the Bestium plugin instance.
    static PluginSupport
    getPluginSupport()
    Returns the plugin support instance, providing access to functions for checking the status of external optional dependencies.

  • Method Details

    • getPlugin

      static JavaPlugin getPlugin()
      Returns the Bestium plugin instance.
      Returns:
      the JavaPlugin instance
      Throws:
      IllegalStateException - if called before the plugin is loaded

    • getBestium

      static Bestium getBestium()
      Returns the Bestium plugin instance cast as Bestium.

      This instance can be safely cast back to a JavaPlugin.

      Returns:
      the Bestium instance
      Throws:
      IllegalStateException - if called before the plugin is loaded

    • getInjector

      static EntityInjector getInjector()
      Returns the main entity injector instance, which handles the registration and management of custom entities within Bestium.
      Returns:
      the injector instance
      See Also:

    • getPluginSupport

      static PluginSupport getPluginSupport()
      Returns the plugin support instance, providing access to functions for checking the status of external optional dependencies.
      Returns:
      the plugin support instance
      Throws:
      IllegalStateException - if called before Bestium plugin is loaded
      See Also:

    • getEntityManager

      static EntityManager getEntityManager()
      Returns the Bestium entity manager instance, handling the initialization, lifecycle and other logic and helper methods for Bestium entities.
      Returns:
      the entity manager instance
      See Also:

    • createKey

      @Internal NamespacedKey createKey(@Value String key)
      Constructs a NamespacedKey from the given string key value.
      Parameters:
      key - the string value of the key. Must follow the KeyPattern.Value format
      Returns:
      a NamespacedKey constructed from the given value