Package journeymap.api.v2.client

Interface IClientPlugin

All Superinterfaces:
IJourneyMapPlugin<IClientAPI>
@ParametersAreNonnullByDefault public interface IClientPlugin extends IJourneyMapPlugin<IClientAPI>
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
    void
    initialize(IClientAPI jmClientApi)
    Called by JourneyMap during the init phase of mod loading.

    Methods inherited from interface journeymap.api.v2.common.IJourneyMapPlugin

    getModId

  • 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.

      Specified by:
      initialize in interface IJourneyMapPlugin<IClientAPI>
      Parameters:
      jmClientApi - Client API implementation