Package org.cyclops.cyclopscore.init

Class ModBase<T extends ModBase>

java.lang.Object
org.cyclops.cyclopscore.init.ModBase<T>
Direct Known Subclasses:
ModBaseVersionable
public abstract class ModBase<T extends ModBase> extends Object
Base class for mods which adds a few convenience methods. Dont forget to call the supers for the init events.

  • Field Details

  • Constructor Details

    • ModBase

      public ModBase(String modId, Consumer<T> instanceSetter, net.neoforged.bus.api.IEventBus modEventBus)

  • Method Details

    • getModName

      public String getModName()

    • getModEventBus

      public net.neoforged.bus.api.IEventBus getModEventBus()

    • getContainer

      public net.neoforged.fml.ModContainer getContainer()
      Returns:
      The mod container of this mod.

    • constructLoggerHelper

      protected LoggerHelper constructLoggerHelper()

    • constructConfigHandler

      protected ConfigHandler constructConfigHandler()

    • constructRegistryManager

      protected RegistryManager constructRegistryManager()

    • constructPacketHandler

      protected PacketHandler constructPacketHandler()

    • constructModCompatLoader

      protected ModCompatLoader constructModCompatLoader()

    • constructCapabilityConstructorRegistry

      protected CapabilityConstructorRegistry constructCapabilityConstructorRegistry()

    • constructIMCHandler

      protected IMCHandler constructIMCHandler()

    • constructBaseCommand

      protected com.mojang.brigadier.builder.LiteralArgumentBuilder<net.minecraft.commands.CommandSourceStack> constructBaseCommand()

    • putGenericReference

      public <T> void putGenericReference(ModBase.EnumReferenceKey<T> key, T value)
      Save a mod value.
      Type Parameters:
      T - The value type.
      Parameters:
      key - The key.
      value - The value.

    • loadModCompats

      protected void loadModCompats(ModCompatLoader modCompatLoader)
      This is called only once to let the mod compatibilities register themselves.
      Parameters:
      modCompatLoader - The loader.

    • getReferenceValue

      public <T> T getReferenceValue(ModBase.EnumReferenceKey<T> key)
      Get the value for a generic reference key. The default keys can be found in ModBase.
      Type Parameters:
      T - The type of value.
      Parameters:
      key - The key of a value.
      Returns:
      The value for the given key.

    • log

      public void log(String message)
      Log a new info message for this mod.
      Parameters:
      message - The message to show.

    • log

      public void log(org.apache.logging.log4j.Level level, String message)
      Log a new message of the given level for this mod.
      Parameters:
      level - The level in which the message must be shown.
      message - The message to show.

    • setup

      protected void setup(net.neoforged.fml.event.lifecycle.FMLCommonSetupEvent event)
      Called on the Forge setup lifecycle event.
      Parameters:
      event - The setup event.

    • setupClient

      protected void setupClient(net.neoforged.fml.event.lifecycle.FMLClientSetupEvent event)
      Called on the Forge client setup lifecycle event.
      Parameters:
      event - The setup event.

    • onRegisterKeyMappings

      protected void onRegisterKeyMappings(net.neoforged.neoforge.client.event.RegisterKeyMappingsEvent event)

    • onServerStarting

      protected void onServerStarting(net.neoforged.neoforge.event.server.ServerStartingEvent event)
      Register the things that are related to when the server is starting.
      Parameters:
      event - The Forge server starting event.

    • onServerAboutToStart

      protected void onServerAboutToStart(net.neoforged.neoforge.event.server.ServerAboutToStartEvent event)
      Register the things that are related to when the server is about to start.
      Parameters:
      event - The Forge server about to start event.

    • onServerStarted

      protected void onServerStarted(net.neoforged.neoforge.event.server.ServerStartedEvent event)
      Register the things that are related to server starting.
      Parameters:
      event - The Forge server started event.

    • onServerStopping

      protected void onServerStopping(net.neoforged.neoforge.event.server.ServerStoppingEvent event)
      Register the things that are related to server stopping, like persistent storage.
      Parameters:
      event - The Forge server stopping event.

    • registerWorldStorage

      public void registerWorldStorage(WorldStorage worldStorage)
      Register a new world storage type. Make sure to call this at least before the event ServerStartedEvent is called.
      Parameters:
      worldStorage - The world storage to register.

    • constructClientProxy

      protected abstract IClientProxy constructClientProxy()

    • constructCommonProxy

      protected abstract ICommonProxy constructCommonProxy()

    • registerDefaultCreativeTabEntry

      public void registerDefaultCreativeTabEntry(net.minecraft.world.item.ItemStack itemStack, net.minecraft.world.item.CreativeModeTab.TabVisibility visibility)

    • constructDefaultCreativeModeTabConfig

      protected CreativeModeTabConfig constructDefaultCreativeModeTabConfig()

    • constructDefaultCreativeModeTab

      protected net.minecraft.world.item.CreativeModeTab.Builder constructDefaultCreativeModeTab(net.minecraft.world.item.CreativeModeTab.Builder builder)

    • hasDefaultCreativeModeTab

      protected boolean hasDefaultCreativeModeTab()
      Returns:
      If a default creative tab should be constructed. If so, make sure to override constructDefaultCreativeModeTab(CreativeModeTab.Builder).

    • onConfigsRegister

      protected void onConfigsRegister(ConfigHandler configHandler)
      Called when the configs should be registered.
      Parameters:
      configHandler - The config handler to register to.

    • getProxy

      public ICommonProxy getProxy()
      Returns:
      The proxy for this mod.

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object object)
      Overrides:
      equals in class Object

    • get

      public static ModBase get(String modId)
      Get the mod by id.
      Parameters:
      modId - The mod id.
      Returns:
      The mod instance or null.