net.minecraftforge.common

Class ModDimension

java.lang.Object

net.minecraftforge.registries.ForgeRegistryEntry<ModDimension>

net.minecraftforge.common.ModDimension

All Implemented Interfaces:

IForgeRegistryEntry<ModDimension>

public abstract class ModDimension
extends ForgeRegistryEntry<ModDimension>

In 1.13.2, Mojang made DimensionType as the unique holder/identifier for each Dimension. We used to be able to create custom Dimensions separate from DimensionType. But now that they are hard linked to a single instance, this is the new class that defines the 'template' for new dimensions.

Field Summary

Fields inherited from class net.minecraftforge.registries.ForgeRegistryEntry

delegate

Constructor Summary

Constructors

Constructor and Description
ModDimension()

Method Summary

Modifier and Type	Method and Description
abstract java.util.function.BiFunction<World,DimensionType,? extends Dimension>	getFactory()
void	read(PacketBuffer buffer, boolean network) Deserialize any necessary data, this is called both when saving the world on the server.
static ModDimension	withFactory(java.util.function.BiFunction<World,DimensionType,? extends Dimension> factory) Convenience method for generating a ModDimension with a specific factory but no extra data handling behaviour.
void	write(PacketBuffer buffer, boolean network) Serialize any necessary data, this is called both when saving the world on the server.

Methods inherited from class net.minecraftforge.registries.ForgeRegistryEntry

getRegistryName, getRegistryType, setRegistryName, setRegistryName, setRegistryName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ModDimension

public ModDimension()

Method Detail

getFactory

public abstract java.util.function.BiFunction<World,DimensionType,? extends Dimension> getFactory()

write

public void write(PacketBuffer buffer,
                  boolean network)

Serialize any necessary data, this is called both when saving the world on the server. And when sent over the network to the client.

Parameters:

buffer - The data buffer to write to.

network - true when sent over the network, so you can only data needed by the client.

read

public void read(PacketBuffer buffer,
                 boolean network)

Deserialize any necessary data, this is called both when saving the world on the server. And when sent over the network to the client.

Parameters:

buffer - The data buffer to write to.

network - true when sent over the network, so you can only data needed by the client.

withFactory

public static ModDimension withFactory(java.util.function.BiFunction<World,DimensionType,? extends Dimension> factory)

Convenience method for generating a ModDimension with a specific factory but no extra data handling behaviour. Extend ModDimension to override other methods.

Parameters:

factory - Factory for creating Dimension instances from DimType and World.

Returns:

A custom ModDimension with that factory.