Class RegistryData

java.lang.Object

net.minestom.server.registry.RegistryData

public final class RegistryData
extends Object

Handles registry data, used by StaticProtocolObject implementations and is strictly internal. Use at your own risk.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	RegistryData.AttributeEntry
static final class	RegistryData.BlockEntry
static final record	RegistryData.BlockSoundTypeEntry
static final class	RegistryData.EntityEntry
static interface	RegistryData.Entry
static final record	RegistryData.FeatureFlagEntry
static final record	RegistryData.FluidEntry
static final record	RegistryData.GameEventEntry
static interface	RegistryData.Loader<T extends StaticProtocolObject<T>>
static final class	RegistryData.MaterialEntry
static final record	RegistryData.PotionEffectEntry
static interface	RegistryData.Properties
static enum	RegistryData.Resource
static final class	RegistryData.VillagerProfessionEntry

Constructor Summary

Constructors

Constructor	Description
RegistryData()

Method Summary

Modifier and Type	Method	Description
static RegistryData.AttributeEntry	attribute(String namespace, @NotNull RegistryData.Properties main)
static RegistryData.BlockEntry	block(String namespace, @NotNull RegistryData.Properties main)
static RegistryData.BlockEntry	block(String namespace, @NotNull RegistryData.Properties main, HashMap<Object,Object> internCache, @Nullable RegistryData.BlockEntry parent, @Nullable RegistryData.Properties parentProperties)
static RegistryData.BlockSoundTypeEntry	blockSoundTypeEntry(String namespace, RegistryData.Properties properties)
static <T extends StaticProtocolObject<T>> @NotNull Registry<T>	createStaticRegistry(@NotNull net.kyori.adventure.key.Key registryKey, @NotNull RegistryData.Loader<T> loader)	Instantiates a static registry from a resource file.
static RegistryData.EntityEntry	entity(String namespace, @NotNull RegistryData.Properties main)
static RegistryData.FeatureFlagEntry	featureFlag(String namespace, @NotNull RegistryData.Properties main)
static RegistryData.FluidEntry	fluid(String namespace, @NotNull RegistryData.Properties main)
static RegistryData.GameEventEntry	gameEventEntry(String namespace, RegistryData.Properties properties)
static RegistryData.Properties	load(String resourcePath, boolean required)
static @Nullable InputStream	loadRegistryFile(@NotNull String path)
static RegistryData.MaterialEntry	material(String namespace, @NotNull RegistryData.Properties main)
static RegistryData.PotionEffectEntry	potionEffect(String namespace, @NotNull RegistryData.Properties main)
static RegistryData.VillagerProfessionEntry	villagerProfession(String namespace, @NotNull RegistryData.Properties main)

Methods inherited from class java.lang.Object

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

Constructor Details

RegistryData

public RegistryData()

Method Details

block

@Internal
public static RegistryData.BlockEntry block(String namespace,
 @NotNull
 @NotNull RegistryData.Properties main)

block

@Internal
public static RegistryData.BlockEntry block(String namespace,
 @NotNull
 @NotNull RegistryData.Properties main,
 HashMap<Object,Object> internCache,
 @Nullable
 @Nullable RegistryData.BlockEntry parent,
 @Nullable
 @Nullable RegistryData.Properties parentProperties)

material

@Internal
public static RegistryData.MaterialEntry material(String namespace,
 @NotNull
 @NotNull RegistryData.Properties main)

entity

@Internal
public static RegistryData.EntityEntry entity(String namespace,
 @NotNull
 @NotNull RegistryData.Properties main)

villagerProfession

@Internal
public static RegistryData.VillagerProfessionEntry villagerProfession(String namespace,
 @NotNull
 @NotNull RegistryData.Properties main)

featureFlag

@Internal
public static RegistryData.FeatureFlagEntry featureFlag(String namespace,
 @NotNull
 @NotNull RegistryData.Properties main)

fluid

@Internal
public static RegistryData.FluidEntry fluid(String namespace,
 @NotNull
 @NotNull RegistryData.Properties main)

potionEffect

@Internal
public static RegistryData.PotionEffectEntry potionEffect(String namespace,
 @NotNull
 @NotNull RegistryData.Properties main)

attribute

@Internal
public static RegistryData.AttributeEntry attribute(String namespace,
 @NotNull
 @NotNull RegistryData.Properties main)

gameEventEntry

public static RegistryData.GameEventEntry gameEventEntry(String namespace,
 RegistryData.Properties properties)

blockSoundTypeEntry

public static RegistryData.BlockSoundTypeEntry blockSoundTypeEntry(String namespace,
 RegistryData.Properties properties)

loadRegistryFile

@Nullable
public static @Nullable InputStream loadRegistryFile(@NotNull
 @NotNull String path)
                                              throws IOException

Parameters:

path - The path without a leading slash, e.g. "blocks.json"

Throws:

IOException

load

@Internal
public static RegistryData.Properties load(String resourcePath,
 boolean required)

createStaticRegistry

@Internal
@NotNull
public static <T extends StaticProtocolObject<T>>
@NotNull Registry<T> createStaticRegistry(@NotNull
 @NotNull net.kyori.adventure.key.Key registryKey,
 @NotNull
 @NotNull RegistryData.Loader<T> loader)

Instantiates a static registry from a resource file. The resource file is resolved using the registryKey first from the classpath, then from the working directory.

The data file should be at /{registryKey.path()}.json

.

Tags will be loaded from /tags/{registryKey.path()}.json