Class BlockModule

java.lang.Object

com.hypixel.hytale.server.core.plugin.PluginBase

com.hypixel.hytale.server.core.plugin.JavaPlugin

com.hypixel.hytale.server.core.modules.block.BlockModule

All Implemented Interfaces:

CommandOwner

public class BlockModule
extends JavaPlugin

A plugin that provides block-related components, resources, and systems.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	BlockModule.BlockEntityPreprocessor
static class	BlockModule.BlockStateInfo	A component that represents the block state information for a block entity.
static class	BlockModule.BlockStateInfoNeedRebuild	A resource that tracks whether block state information needs to be rebuilt.
static class	BlockModule.BlockStateInfoRefSystem	A ref system that manages the references from BlockModule.BlockStateInfo components to their respective BlockComponentSection instances.
static class	BlockModule.ItemContainerStateRefSystem
static class	BlockModule.MigrateItemContainer
static class	BlockModule.MigrationSystem	A migration system that performs data migrations for block-related components.

Field Summary

Fields

Modifier and Type	Field	Description
static final PluginManifest	MANIFEST	The plugin manifest for the BlockModule plugin.

Fields inherited from class PluginBase

METRICS_REGISTRY

Constructor Summary

Constructors

Constructor	Description
BlockModule(JavaPluginInit init)	Default Constructor of a BlockModule instance.

Method Summary

Modifier and Type	Method	Description
static BlockModule	get()
static Ref<ChunkStore>	getBlockEntity(ComponentAccessor<ChunkStore> accessor, Ref<ChunkStore> sectionRef, int x, int y, int z)	Looks up the live block entity at the given world position within an already-resolved section, for callers holding a Store or CommandBuffer rather than the world.
static Ref<ChunkStore>	getBlockEntity(World world, int x, int y, int z)
ComponentType<ChunkStore, BlockMapMarker>	getBlockMapMarkerComponentType()
ResourceType<ChunkStore, BlockMapMarkersResource>	getBlockMapMarkersResourceType()
ComponentType<ChunkStore, BlockModule.BlockStateInfo>	getBlockStateInfoComponentType()
ResourceType<ChunkStore, BlockModule.BlockStateInfoNeedRebuild>	getBlockStateInfoNeedRebuildResourceType()
static <T extends Component<ChunkStore>> T	getComponent(ComponentType<ChunkStore, T> componentType, World world, int x, int y, int z)
ComponentType<ChunkStore, ItemContainerBlock>	getItemContainerBlockComponentType()
ResourceType<ChunkStore, SpatialResource<Ref<ChunkStore>, ChunkStore>>	getItemContainerSpatialResourceType()
ComponentType<ChunkStore, LaunchPad>	getLaunchPadComponentType()
SystemType<ChunkStore, BlockModule.MigrationSystem>	getMigrationSystemType()
ComponentType<ChunkStore, RespawnBlock>	getRespawnBlockComponentType()

Methods inherited from class JavaPlugin

getClassLoader, getFile, getType

Methods inherited from class PluginBase

getAssetRegistry, getBasePermission, getChunkStoreRegistry, getClientFeatureRegistry, getCodecRegistry, getCodecRegistry, getCodecRegistry, getCommandRegistry, getDataDirectory, getEntityRegistry, getEntityStoreRegistry, getEventRegistry, getIdentifier, getLogger, getManifest, getName, getState, getTaskRegistry, isDisabled, isEnabled, preLoad

Methods inherited from class Object

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

Field Details

MANIFEST

public static final PluginManifest MANIFEST

The plugin manifest for the BlockModule plugin.

Constructor Details

BlockModule

public BlockModule(@Nonnull
 JavaPluginInit init)

Default Constructor of a BlockModule instance.

Parameters:

init - The plugin initialization step for this plugin.

Method Details

get

public static BlockModule get()

Returns:

the singleton instance of the BlockModule.

getMigrationSystemType

public SystemType<ChunkStore, BlockModule.MigrationSystem> getMigrationSystemType()

Returns:

the component type for the BlockModule.MigrationSystem component.

getBlockStateInfoComponentType

public ComponentType<ChunkStore, BlockModule.BlockStateInfo> getBlockStateInfoComponentType()

Returns:

the component type for the BlockModule.BlockStateInfo component.

getLaunchPadComponentType

public ComponentType<ChunkStore, LaunchPad> getLaunchPadComponentType()

Returns:

the component type for the LaunchPad component.

getRespawnBlockComponentType

public ComponentType<ChunkStore, RespawnBlock> getRespawnBlockComponentType()

Returns:

the component type for the RespawnBlock component.

getBlockMapMarkerComponentType

public ComponentType<ChunkStore, BlockMapMarker> getBlockMapMarkerComponentType()

Returns:

the component type for the BlockMapMarker component.

getBlockMapMarkersResourceType

public ResourceType<ChunkStore, BlockMapMarkersResource> getBlockMapMarkersResourceType()

Returns:

the resource type for the BlockMapMarkersResource resource.

getBlockStateInfoNeedRebuildResourceType

public ResourceType<ChunkStore, BlockModule.BlockStateInfoNeedRebuild> getBlockStateInfoNeedRebuildResourceType()

Returns:

the resource type for the BlockModule.BlockStateInfoNeedRebuild resource.

getItemContainerBlockComponentType

public ComponentType<ChunkStore, ItemContainerBlock> getItemContainerBlockComponentType()

getItemContainerSpatialResourceType

public ResourceType<ChunkStore, SpatialResource<Ref<ChunkStore>, ChunkStore>> getItemContainerSpatialResourceType()

getBlockEntity

@Nullable
public static Ref<ChunkStore> getBlockEntity(@Nonnull
 World world,
 int x,
 int y,
 int z)

getBlockEntity

@Nullable
public static Ref<ChunkStore> getBlockEntity(@Nonnull
 ComponentAccessor<ChunkStore> accessor,
 @Nonnull
 Ref<ChunkStore> sectionRef,
 int x,
 int y,
 int z)

Looks up the live block entity at the given world position within an already-resolved section, for callers holding a Store or CommandBuffer rather than the world.

Returns:

the block entity's validated reference, or null if the position has none.

getComponent

@Nullable
public static <T extends Component<ChunkStore>> T getComponent(ComponentType<ChunkStore, T> componentType,
 World world,
 int x,
 int y,
 int z)