mirror of
https://github.com/MinecraftForge/MinecraftForge.git
synced 2026-11-18 11:29:15 +00:00
Deprecate DistExecutor for removal (#10198)
This commit is contained in:
1 parent
31f623e794
commit
63d0496cc4
5 files changed
+69
-12
No files matched your search
@@ -25,7 +25,18 @@ import java.util.function.Supplier;
|
||||
* <li>When you want to call one thing on one side, another thing on the other and return a result {@link #safeRunForDist(Supplier, Supplier)}</li>
|
||||
* <li>When you want to run something on one side {@link #safeRunWhenOn(Dist, Supplier)}</li>
|
||||
* </ul>
|
||||
*
|
||||
* @deprecated Historically, this allowed for safe execution of code on the correct side by exploiting a low-level
|
||||
* detail in Java 8, but in newer versions a simple if check is enough.
|
||||
* <br>
|
||||
* For example:
|
||||
* <pre>{@code
|
||||
* if (FMLEnvironment.dist.isClient()) {
|
||||
* // client code here
|
||||
* }
|
||||
* }</pre>
|
||||
*/
|
||||
@Deprecated(since = "1.21.5", forRemoval = true)
|
||||
public final class DistExecutor
|
||||
{
|
||||
private static final Logger LOGGER = LogManager.getLogger();
|
||||
|
||||
@@ -6,9 +6,9 @@
|
||||
package net.minecraftforge.fml.core;
|
||||
|
||||
import net.minecraftforge.api.distmarker.Dist;
|
||||
import net.minecraftforge.fml.DistExecutor;
|
||||
import net.minecraftforge.fml.IModLoadingState;
|
||||
import net.minecraftforge.fml.IModStateProvider;
|
||||
import net.minecraftforge.fml.ModContainer;
|
||||
import net.minecraftforge.fml.ModLoadingPhase;
|
||||
import net.minecraftforge.fml.ModLoadingStage;
|
||||
import net.minecraftforge.fml.ModLoadingState;
|
||||
@@ -21,9 +21,12 @@ import net.minecraftforge.fml.event.lifecycle.FMLDedicatedServerSetupEvent;
|
||||
import net.minecraftforge.fml.event.lifecycle.FMLLoadCompleteEvent;
|
||||
import net.minecraftforge.fml.event.lifecycle.InterModEnqueueEvent;
|
||||
import net.minecraftforge.fml.event.lifecycle.InterModProcessEvent;
|
||||
import net.minecraftforge.fml.event.lifecycle.ParallelDispatchEvent;
|
||||
import net.minecraftforge.fml.loading.FMLEnvironment;
|
||||
import net.minecraftforge.fml.loading.FMLPaths;
|
||||
|
||||
import java.util.List;
|
||||
import java.util.function.BiFunction;
|
||||
|
||||
/**
|
||||
* Provider for the core FML mod loading states.
|
||||
@@ -60,7 +63,7 @@ public class ModStateProvider implements IModStateProvider {
|
||||
*/
|
||||
public static final ModLoadingState CONFIG_LOAD = ModLoadingState.of("CONFIG_LOAD", ModLoadingPhase.LOAD)
|
||||
.withInline(ml -> {
|
||||
DistExecutor.unsafeRunWhenOn(Dist.CLIENT, () -> () -> ConfigTracker.INSTANCE.loadConfigs(ModConfig.Type.CLIENT, FMLPaths.CONFIGDIR.get()));
|
||||
if (FMLEnvironment.dist.isClient()) ConfigTracker.INSTANCE.loadConfigs(ModConfig.Type.CLIENT, FMLPaths.CONFIGDIR.get());
|
||||
ConfigTracker.INSTANCE.loadConfigs(ModConfig.Type.COMMON, FMLPaths.CONFIGDIR.get());
|
||||
});
|
||||
|
||||
@@ -71,7 +74,7 @@ public class ModStateProvider implements IModStateProvider {
|
||||
* @see FMLCommonSetupEvent
|
||||
* @see ModLoadingStage#COMMON_SETUP
|
||||
*/
|
||||
public static final ModLoadingState COMMON_SETUP = ModLoadingState.of("COMMON_SETUP", ModLoadingPhase.LOAD)
|
||||
public static final ModLoadingState COMMON_SETUP = ModLoadingState.of("COMMON_SETUP", ModLoadingPhase.LOAD)
|
||||
.after(CONFIG_LOAD)
|
||||
.withTransition(new ParallelTransition(ModLoadingStage.COMMON_SETUP, FMLCommonSetupEvent::new));
|
||||
|
||||
@@ -83,14 +86,16 @@ public class ModStateProvider implements IModStateProvider {
|
||||
* @see FMLDedicatedServerSetupEvent
|
||||
* @see ModLoadingStage#SIDED_SETUP
|
||||
*/
|
||||
public static final ModLoadingState SIDED_SETUP = ModLoadingState.of("SIDED_SETUP", ModLoadingPhase.LOAD)
|
||||
public static final ModLoadingState SIDED_SETUP = ModLoadingState.of("SIDED_SETUP", ModLoadingPhase.LOAD)
|
||||
.after(COMMON_SETUP)
|
||||
.withTransition(new ParallelTransition(ModLoadingStage.SIDED_SETUP,
|
||||
DistExecutor.unsafeRunForDist(
|
||||
() -> () -> FMLClientSetupEvent::new,
|
||||
() -> () -> FMLDedicatedServerSetupEvent::new
|
||||
)
|
||||
));
|
||||
.withTransition(new ParallelTransition(ModLoadingStage.SIDED_SETUP, createSidedSetupEvent()));
|
||||
|
||||
private static BiFunction<ModContainer, ModLoadingStage, ParallelDispatchEvent> createSidedSetupEvent() {
|
||||
if (FMLEnvironment.dist.isClient())
|
||||
return FMLClientSetupEvent::new;
|
||||
else
|
||||
return FMLDedicatedServerSetupEvent::new;
|
||||
}
|
||||
|
||||
/**
|
||||
* First {@linkplain ModLoadingPhase#COMPLETE completion state}, for enqueuing {@link net.minecraftforge.fml.InterModComms}
|
||||
@@ -99,7 +104,7 @@ public class ModStateProvider implements IModStateProvider {
|
||||
* @see InterModEnqueueEvent
|
||||
* @see ModLoadingStage#ENQUEUE_IMC
|
||||
*/
|
||||
public static final ModLoadingState ENQUEUE_IMC = ModLoadingState.of("ENQUEUE_IMC", ModLoadingPhase.COMPLETE)
|
||||
public static final ModLoadingState ENQUEUE_IMC = ModLoadingState.of("ENQUEUE_IMC", ModLoadingPhase.COMPLETE)
|
||||
.withTransition(new ParallelTransition(ModLoadingStage.ENQUEUE_IMC, InterModEnqueueEvent::new));
|
||||
|
||||
/**
|
||||
|
||||
@@ -23,6 +23,7 @@ import net.minecraft.world.level.storage.LevelResource;
|
||||
import net.minecraftforge.common.world.StructureModifier;
|
||||
import net.minecraftforge.common.util.LogicalSidedProvider;
|
||||
import net.minecraftforge.common.world.BiomeModifier;
|
||||
import net.minecraftforge.fml.loading.FMLEnvironment;
|
||||
import net.minecraftforge.network.ConnectionType;
|
||||
import net.minecraftforge.network.NetworkContext;
|
||||
import net.minecraftforge.network.NetworkRegistry;
|
||||
@@ -37,7 +38,6 @@ import net.minecraft.server.MinecraftServer;
|
||||
import net.minecraftforge.common.MinecraftForge;
|
||||
import net.minecraftforge.fml.config.ConfigTracker;
|
||||
import net.minecraftforge.fml.config.ModConfig;
|
||||
import net.minecraftforge.fml.loading.FMLEnvironment;
|
||||
import net.minecraftforge.event.server.ServerAboutToStartEvent;
|
||||
import net.minecraftforge.event.server.ServerStartedEvent;
|
||||
import net.minecraftforge.event.server.ServerStartingEvent;
|
||||
|
||||
+7
@@ -0,0 +1,7 @@
|
||||
{
|
||||
"type": "minecraft:function",
|
||||
"environment": "minecraft:default",
|
||||
"function": "forge:dist_executor/prevent_client_on_server",
|
||||
"max_ticks": 100,
|
||||
"structure": "forge:empty3x3x3"
|
||||
}
|
||||
@@ -0,0 +1,34 @@
|
||||
package net.minecraftforge.debug.dist;
|
||||
|
||||
import net.minecraft.client.Minecraft;
|
||||
import net.minecraft.gametest.framework.GameTestHelper;
|
||||
import net.minecraftforge.api.distmarker.Dist;
|
||||
import net.minecraftforge.fml.common.Mod;
|
||||
import net.minecraftforge.fml.javafmlmod.FMLJavaModLoadingContext;
|
||||
import net.minecraftforge.fml.loading.FMLEnvironment;
|
||||
import net.minecraftforge.gametest.GameTest;
|
||||
import net.minecraftforge.gametest.GameTestNamespace;
|
||||
import net.minecraftforge.test.BaseTestMod;
|
||||
|
||||
@Mod(DistExecutorTest.MOD_ID)
|
||||
@GameTestNamespace("forge")
|
||||
public class DistExecutorTest extends BaseTestMod {
|
||||
static final String MOD_ID = "dist_executor";
|
||||
|
||||
public DistExecutorTest(FMLJavaModLoadingContext context) {
|
||||
super(context);
|
||||
}
|
||||
|
||||
@GameTest
|
||||
public static void preventClientOnServer(GameTestHelper helper) {
|
||||
try {
|
||||
if (FMLEnvironment.dist == Dist.CLIENT) {
|
||||
Minecraft.getInstance().getWindow();
|
||||
}
|
||||
} catch (Throwable throwable) {
|
||||
helper.fail("Client class was loaded on server! " + throwable);
|
||||
}
|
||||
|
||||
helper.succeed();
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user