Package journeymap.api.v2.client

Interface IClientPlugin

@ParametersAreNonnullByDefault public interface IClientPlugin
Interface used by JourneyMap to initialize client plugins and provide the Client API.

Implementation classes must have a no-arg constructor and also have the JourneyMapPlugin annotation.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getModId()
    Used by JourneyMap to associate your mod id with your plugin instance.
    void
    initialize(IClientAPI jmClientApi)
    Called by JourneyMap during the init phase of mod loading.

  • Method Details

    • initialize

      void initialize(IClientAPI jmClientApi)
      Called by JourneyMap during the init phase of mod loading. Your implementation should retain a reference to the IClientAPI passed in, since that is what your plugin will use to add overlays, etc. to JourneyMap.

      This is also a good time to call ClientEventRegistry to subscribe to any desired Events.

      Parameters:
      jmClientApi - Client API implementation

    • getModId

      String getModId()
      Used by JourneyMap to associate your mod id with your plugin instance.