Package org.cyclops.cyclopscore.init

Class ModBaseNeoForge<T extends ModBaseNeoForge<T>>

java.lang.Object
org.cyclops.cyclopscore.helper.ModBaseCommon<T>
org.cyclops.cyclopscore.init.ModBaseNeoForge<T>
All Implemented Interfaces:
org.cyclops.cyclopscore.init.IModBase
Direct Known Subclasses:
CyclopsCoreNeoForge
public abstract class ModBaseNeoForge<T extends ModBaseNeoForge<T>> extends org.cyclops.cyclopscore.helper.ModBaseCommon<T>
Base class for mods which adds a few convenience methods.

  • Field Details

  • Constructor Details

    • ModBaseNeoForge

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

  • Method Details

    • constructClientProxy

      protected abstract IClientProxy constructClientProxy()
      Specified by:
      constructClientProxy in class org.cyclops.cyclopscore.helper.ModBaseCommon<T extends ModBaseNeoForge<T>>

    • constructCommonProxy

      protected abstract ICommonProxy constructCommonProxy()
      Specified by:
      constructCommonProxy in class org.cyclops.cyclopscore.helper.ModBaseCommon<T extends ModBaseNeoForge<T>>

    • getModHelpers

      public IModHelpersNeoForge getModHelpers()

    • getProxy

      public ICommonProxy getProxy()

    • getConfigHandler

      public org.cyclops.cyclopscore.config.ConfigHandlerCommon getConfigHandler()

    • getGenericReference

      public Map<ModBaseNeoForge.EnumReferenceKey<?>,Object> getGenericReference()

    • getWorldStorages

      public List<WorldStorage.Access<?>> getWorldStorages()

    • getKeyRegistry

      public IKeyRegistry getKeyRegistry()

    • getPacketHandler

      public org.cyclops.cyclopscore.network.IPacketHandler getPacketHandler()

    • getCapabilityConstructorRegistry

      public CapabilityConstructorRegistry getCapabilityConstructorRegistry()

    • getImcHandler

      public IMCHandler getImcHandler()

    • 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 org.cyclops.cyclopscore.helper.LoggerHelper constructLoggerHelper()
      Overrides:
      constructLoggerHelper in class org.cyclops.cyclopscore.helper.ModBaseCommon<T extends ModBaseNeoForge<T>>

    • constructConfigHandler

      protected org.cyclops.cyclopscore.config.ConfigHandlerCommon constructConfigHandler()

    • constructPacketHandler

      protected PacketHandlerNeoForge constructPacketHandler()

    • constructCapabilityConstructorRegistry

      protected CapabilityConstructorRegistry constructCapabilityConstructorRegistry()

    • constructIMCHandler

      protected IMCHandler constructIMCHandler()

    • constructBaseCommand

      protected com.mojang.brigadier.builder.LiteralArgumentBuilder<net.minecraft.commands.CommandSourceStack> constructBaseCommand(net.minecraft.commands.Commands.CommandSelection selection, net.minecraft.commands.CommandBuildContext context)
      Overrides:
      constructBaseCommand in class org.cyclops.cyclopscore.helper.ModBaseCommon<T extends ModBaseNeoForge<T>>

    • putGenericReference

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

    • getReferenceValue

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

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

    • registerGameTests

      protected void registerGameTests(net.neoforged.neoforge.event.RegisterGameTestsEvent 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.

    • onRegisterCommands

      protected void onRegisterCommands(net.neoforged.neoforge.event.RegisterCommandsEvent 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.Access<?> 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.

    • get

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

    • getMods

      public static Map<String,ModBaseNeoForge<?>> getMods()