Class BuilderToolsPlugin

java.lang.Object

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

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

com.hypixel.hytale.builtin.buildertools.BuilderToolsPlugin

All Implemented Interfaces:

MetricProvider, CommandOwner, SelectionProvider

public class BuilderToolsPlugin
extends JavaPlugin
implements SelectionProvider, MetricProvider

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	BuilderToolsPlugin.Action
static class	BuilderToolsPlugin.ActionEntry
static class	BuilderToolsPlugin.BuilderState
static class	BuilderToolsPlugin.BuilderToolsConfig
static final record	BuilderToolsPlugin.ColorGradientMaterial
static class	BuilderToolsPlugin.PrefabPasteEventSystem	A system to handle PrefabPasteEvent events.
static enum	BuilderToolsPlugin.ShadingLight
static interface	BuilderToolsPlugin.TaskRegion	The area a queued task works on, and how to load it.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EDITOR_BLOCK
static final String	EDITOR_BLOCK_PREFAB_AIR
static final String	EDITOR_BLOCK_PREFAB_ANCHOR
static final BuilderToolsPlugin.TaskRegion	SELECTION_REGION	The region of a task that reads or fills the current selection, so the area under it is loaded before the task runs.
static final int	SHAPE_PREVIEW_MAX_VOLUME
static final int	SHAPE_PREVIEW_THRESHOLD
static final int	STREAM_TO_CLIENT_LIMIT

Fields inherited from class PluginBase

METRICS_REGISTRY

Constructor Summary

Constructors

Constructor	Description
BuilderToolsPlugin(JavaPluginInit init)

Method Summary

Modifier and Type	Method	Description
static <T extends Throwable> void	addToQueue(Player player, PlayerRef playerRef, long estimatedBlockChanges, BuilderToolsPlugin.TaskRegion region, ThrowableTriConsumer<Ref<EntityStore>, BuilderToolsPlugin.BuilderState, ComponentAccessor<EntityStore>, T> task)
static <T extends Throwable> void	addToQueue(Player player, PlayerRef playerRef, long estimatedBlockChanges, ThrowableTriConsumer<Ref<EntityStore>, BuilderToolsPlugin.BuilderState, ComponentAccessor<EntityStore>, T> task)
static <T extends Throwable> void	addToQueue(Player player, PlayerRef playerRef, BuilderToolsPlugin.TaskRegion region, ThrowableTriConsumer<Ref<EntityStore>, BuilderToolsPlugin.BuilderState, ComponentAccessor<EntityStore>, T> task)
static <T extends Throwable> void	addToQueue(Player player, PlayerRef playerRef, ThrowableTriConsumer<Ref<EntityStore>, BuilderToolsPlugin.BuilderState, ComponentAccessor<EntityStore>, T> task)
BuilderToolsPlugin.BuilderState	clearBuilderState(UUID uuid)	Immediately remove the BuilderState associated with the UUID bypassing any expire-time or persistence checks.
<T extends Throwable> void	computeSelectionCopy(Ref<EntityStore> ref, Player player, ThrowableConsumer<BlockSelection, T> task, ComponentAccessor<EntityStore> componentAccessor)	Computes a copy of the given Player's BlockSelection and performs the provided task with it.
static Holder<ChunkStore>	createBlockComponent(int newId, int oldId, Holder<ChunkStore> oldHolder, boolean copy)	Deprecated.
static void	forEachCopyableInSelection(World world, int minX, int minY, int minZ, int width, int height, int depth, Consumer<Ref<EntityStore>> action)	Helper method for safely iterating all copyable ECS entities within a selection volume who's lower corner is position in the world at min x/y/z and has the dimensions width/height/depth (length x, length y, length z respectively).
static BuilderToolsPlugin	get()
BlockColorIndex	getBlockColorIndex()
BuilderToolsPlugin.BuilderState	getBuilderState(Player player, PlayerRef playerRef)
BiConsumer<PlayerRef, Store<EntityStore>>	getBuilderToolModeDeactivatedCallback()
List<PrefabSaveContributor>	getClipboardContributors()
static BlockSelection	getMaskSelection(BlockSelection selection)	Returns the selection that the # block mask filter matches against, or null when the player has no selection area.
UUID	getNewPathIdOnPrefabPasted(UUID id, String name, int prefabId)
com.hypixel.fastutil.ints.Int2ObjectConcurrentHashMap<ConcurrentHashMap<UUID,UUID>>	getPastedPrefabPathUUIDMap()
ComponentType<EntityStore, PrefabAnchor>	getPrefabAnchorComponentType()
PrefabEditSessionManager	getPrefabEditSessionManager()
ResourceType<EntityStore, PrefabEditSession>	getPrefabEditSessionResourceType()
List<PrefabSaveContributor>	getPrefabSaveContributors()
ExecutorService	getPrefabSaveExecutor()	Shared with PrefabSaver so saves to the same file stay ordered regardless of which path triggered them.
BiConsumer<PlayerRef, Store<EntityStore>>	getSelectionBoundsUpdatedCallback()
BiConsumer<PlayerRef, Store<EntityStore>>	getSelectionClearedCallback()
static BuilderToolsPlugin.BuilderState	getState(Player player, PlayerRef playerRef)
ComponentType<EntityStore, BuilderToolsUserData>	getUserDataComponentType()
static void	invalidateWorldMapForBounds(org.joml.Vector3i min, org.joml.Vector3i max, World world)
static void	invalidateWorldMapForSelection(BlockSelection selection, World world)
void	onPasteEnd(int prefabId, ComponentAccessor<EntityStore> componentAccessor)
static boolean	onPasteStart(int prefabId, ComponentAccessor<EntityStore> componentAccessor)
void	onToolArgUpdate(Ref<EntityStore> ref, PlayerRef playerRef, BuilderToolArgUpdate packet, ComponentAccessor<EntityStore> componentAccessor)
static List<BuilderToolsPlugin.ColorGradientMaterial>	parseGradientMaterials(String materialsStr)
static Prefetch.Budget	prefetchBudget()	How much a load may bring in, as the configuration last read it.
void	registerClipboardContributor(PrefabSaveContributor contributor)
void	registerPrefabSaveContributor(PrefabSaveContributor contributor)
static AssetPack	resolveTargetPack(String explicitPackName, Player playerComponent, CommandContext context)
static AssetPack	resolveTargetPack(String explicitPackName, Path prefabPath, Player playerComponent, CommandContext context)
static void	sendFeedback(Message message, CommandSender feedback, NotificationStyle notificationStyle, ComponentAccessor<EntityStore> componentAccessor)
static void	sendFeedback(Message message, CommandSender feedback, NotificationStyle notificationStyle, String tag, ComponentAccessor<EntityStore> componentAccessor)
static void	sendFeedback(String key, int total, int num, CommandSender feedback, ComponentAccessor<EntityStore> componentAccessor)
static void	sendFeedback(String key, int total, CommandSender feedback, ComponentAccessor<EntityStore> componentAccessor)
void	setBuilderToolModeDeactivatedCallback(BiConsumer<PlayerRef, Store<EntityStore>> callback)
void	setSelectionBoundsUpdatedCallback(BiConsumer<PlayerRef, Store<EntityStore>> callback)
void	setSelectionClearedCallback(BiConsumer<PlayerRef, Store<EntityStore>> callback)
void	setToolHistorySize(int size)
MetricResults	toMetricResults()

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

EDITOR_BLOCK

public static final String EDITOR_BLOCK

See Also:

• Constant Field Values

EDITOR_BLOCK_PREFAB_AIR

public static final String EDITOR_BLOCK_PREFAB_AIR

See Also:

• Constant Field Values

EDITOR_BLOCK_PREFAB_ANCHOR

public static final String EDITOR_BLOCK_PREFAB_ANCHOR

See Also:

• Constant Field Values

STREAM_TO_CLIENT_LIMIT

public static final int STREAM_TO_CLIENT_LIMIT

See Also:

• Constant Field Values

SHAPE_PREVIEW_THRESHOLD

public static final int SHAPE_PREVIEW_THRESHOLD

See Also:

• Constant Field Values

SHAPE_PREVIEW_MAX_VOLUME

public static final int SHAPE_PREVIEW_MAX_VOLUME

See Also:

• Constant Field Values

SELECTION_REGION

@Nonnull
public static final BuilderToolsPlugin.TaskRegion SELECTION_REGION

The region of a task that reads or fills the current selection, so the area under it is loaded before the task runs. Queue with this region for a command that works on the selection. Queue with no region for a brush or a tool, which works where the player aims and must not load a selection it never touches.

Constructor Details

BuilderToolsPlugin

public BuilderToolsPlugin(@Nonnull
 JavaPluginInit init)

Method Details

parseGradientMaterials

@Nonnull
public static List<BuilderToolsPlugin.ColorGradientMaterial> parseGradientMaterials(@Nullable
 String materialsStr)

getPrefabSaveExecutor

@Nonnull
public ExecutorService getPrefabSaveExecutor()

Shared with PrefabSaver so saves to the same file stay ordered regardless of which path triggered them.

get

public static BuilderToolsPlugin get()

prefetchBudget

@Nonnull
public static Prefetch.Budget prefetchBudget()

How much a load may bring in, as the configuration last read it.

registerPrefabSaveContributor

public void registerPrefabSaveContributor(@Nonnull
 PrefabSaveContributor contributor)

getPrefabSaveContributors

@Nonnull
public List<PrefabSaveContributor> getPrefabSaveContributors()

registerClipboardContributor

public void registerClipboardContributor(@Nonnull
 PrefabSaveContributor contributor)

getClipboardContributors

@Nonnull
public List<PrefabSaveContributor> getClipboardContributors()

setSelectionBoundsUpdatedCallback

public void setSelectionBoundsUpdatedCallback(@Nullable
 BiConsumer<PlayerRef, Store<EntityStore>> callback)

setBuilderToolModeDeactivatedCallback

public void setBuilderToolModeDeactivatedCallback(@Nullable
 BiConsumer<PlayerRef, Store<EntityStore>> callback)

setSelectionClearedCallback

public void setSelectionClearedCallback(@Nullable
 BiConsumer<PlayerRef, Store<EntityStore>> callback)

getSelectionBoundsUpdatedCallback

@Nullable
public BiConsumer<PlayerRef, Store<EntityStore>> getSelectionBoundsUpdatedCallback()

getBuilderToolModeDeactivatedCallback

@Nullable
public BiConsumer<PlayerRef, Store<EntityStore>> getBuilderToolModeDeactivatedCallback()

getSelectionClearedCallback

@Nullable
public BiConsumer<PlayerRef, Store<EntityStore>> getSelectionClearedCallback()

getBlockColorIndex

@Nonnull
public BlockColorIndex getBlockColorIndex()

Returns:

the shared block color index for color-to-block matching

invalidateWorldMapForSelection

public static void invalidateWorldMapForSelection(@Nonnull
 BlockSelection selection,
 @Nonnull
 World world)

invalidateWorldMapForBounds

public static void invalidateWorldMapForBounds(@Nonnull
 org.joml.Vector3i min,
 @Nonnull
 org.joml.Vector3i max,
 @Nonnull
 World world)

getState

@Nonnull
public static BuilderToolsPlugin.BuilderState getState(@Nonnull
 Player player,
 @Nonnull
 PlayerRef playerRef)

getMaskSelection

@Nullable
public static BlockSelection getMaskSelection(@Nullable
 BlockSelection selection)

Returns the selection that the # block mask filter matches against, or null when the player has no selection area. A BlockSelection can exist before its area is set, and the filter must match nothing in that state rather than match the block at the world origin.

addToQueue

public static <T extends Throwable> void addToQueue(@Nonnull
 Player player,
 @Nonnull
 PlayerRef playerRef,
 @Nonnull
 ThrowableTriConsumer<Ref<EntityStore>, BuilderToolsPlugin.BuilderState, ComponentAccessor<EntityStore>, T> task)

addToQueue

public static <T extends Throwable> void addToQueue(@Nonnull
 Player player,
 @Nonnull
 PlayerRef playerRef,
 long estimatedBlockChanges,
 @Nonnull
 ThrowableTriConsumer<Ref<EntityStore>, BuilderToolsPlugin.BuilderState, ComponentAccessor<EntityStore>, T> task)

addToQueue

public static <T extends Throwable> void addToQueue(@Nonnull
 Player player,
 @Nonnull
 PlayerRef playerRef,
 @Nullable
 BuilderToolsPlugin.TaskRegion region,
 @Nonnull
 ThrowableTriConsumer<Ref<EntityStore>, BuilderToolsPlugin.BuilderState, ComponentAccessor<EntityStore>, T> task)

addToQueue

public static <T extends Throwable> void addToQueue(@Nonnull
 Player player,
 @Nonnull
 PlayerRef playerRef,
 long estimatedBlockChanges,
 @Nullable
 BuilderToolsPlugin.TaskRegion region,
 @Nonnull
 ThrowableTriConsumer<Ref<EntityStore>, BuilderToolsPlugin.BuilderState, ComponentAccessor<EntityStore>, T> task)

resolveTargetPack

@Nullable
public static AssetPack resolveTargetPack(@Nonnull
 String explicitPackName,
 @Nonnull
 Player playerComponent,
 @Nonnull
 CommandContext context)

resolveTargetPack

@Nullable
public static AssetPack resolveTargetPack(@Nonnull
 String explicitPackName,
 @Nullable
 Path prefabPath,
 @Nonnull
 Player playerComponent,
 @Nonnull
 CommandContext context)

getPrefabEditSessionResourceType

public ResourceType<EntityStore, PrefabEditSession> getPrefabEditSessionResourceType()

setToolHistorySize

public void setToolHistorySize(int size)

onToolArgUpdate

public void onToolArgUpdate(@Nonnull
 Ref<EntityStore> ref,
 @Nonnull
 PlayerRef playerRef,
 @Nonnull
 BuilderToolArgUpdate packet,
 @Nonnull
 ComponentAccessor<EntityStore> componentAccessor)

getBuilderState

@Nonnull
public BuilderToolsPlugin.BuilderState getBuilderState(@Nonnull
 Player player,
 @Nonnull
 PlayerRef playerRef)

clearBuilderState

@Nullable
public BuilderToolsPlugin.BuilderState clearBuilderState(UUID uuid)

Immediately remove the BuilderState associated with the UUID bypassing any expire-time or persistence checks.

Parameters:

uuid - The UUID of the Player whose BuilderState should be removed.

Returns:

The removed BuilderState if present, or null.

getUserDataComponentType

public ComponentType<EntityStore, BuilderToolsUserData> getUserDataComponentType()

sendFeedback

public static void sendFeedback(@Nonnull
 Message message,
 @Nullable
 CommandSender feedback,
 @Nonnull
 NotificationStyle notificationStyle,
 @Nonnull
 ComponentAccessor<EntityStore> componentAccessor)

sendFeedback

public static void sendFeedback(@Nonnull
 Message message,
 @Nullable
 CommandSender feedback,
 @Nonnull
 NotificationStyle notificationStyle,
 @Nullable
 String tag,
 @Nonnull
 ComponentAccessor<EntityStore> componentAccessor)

sendFeedback

public static void sendFeedback(@Nonnull
 String key,
 int total,
 CommandSender feedback,
 ComponentAccessor<EntityStore> componentAccessor)

sendFeedback

public static void sendFeedback(@Nonnull
 String key,
 int total,
 int num,
 CommandSender feedback,
 ComponentAccessor<EntityStore> componentAccessor)

computeSelectionCopy

public <T extends Throwable> void computeSelectionCopy(@Nonnull
 Ref<EntityStore> ref,
 @Nonnull
 Player player,
 @Nonnull
 ThrowableConsumer<BlockSelection, T> task,
 @Nonnull
 ComponentAccessor<EntityStore> componentAccessor)

Description copied from interface: SelectionProvider

Computes a copy of the given Player's BlockSelection and performs the provided task with it.

Specified by:

computeSelectionCopy in interface SelectionProvider

Type Parameters:

T - The type of exception that may be thrown by the task.

Parameters:

ref - The entity reference of the instigating entity.

player - The Player whose selection should be retrieved.

task - The task to perform on the selection.

componentAccessor - The ComponentAccessor<EntityStore> for component access.

toMetricResults

@Nonnull
public MetricResults toMetricResults()

Specified by:

toMetricResults in interface MetricProvider

getPrefabAnchorComponentType

public ComponentType<EntityStore, PrefabAnchor> getPrefabAnchorComponentType()

getPrefabEditSessionManager

public PrefabEditSessionManager getPrefabEditSessionManager()

createBlockComponent

@Nullable
@Deprecated
public static Holder<ChunkStore> createBlockComponent(int newId,
 int oldId,
 @Nullable
 Holder<ChunkStore> oldHolder,
 boolean copy)

Deprecated.

Returns a new BlockState holder to replace the existing one when setting/replacing a block at a position in the chunk.

Parameters:

newId - The new block id being set at the position in the chunk.

oldId - The current block id value held at the position in the chunk.

oldHolder - The current BlockState data held at the position in the chunk.

copy - A flag controlling whether the existing BlockState data should be copied when it is valid for the new BlockType.

Returns:

The BlockState holder that will replace the old one or null.

forEachCopyableInSelection

public static void forEachCopyableInSelection(@Nonnull
 World world,
 int minX,
 int minY,
 int minZ,
 int width,
 int height,
 int depth,
 @Nonnull
 Consumer<Ref<EntityStore>> action)

Helper method for safely iterating all copyable ECS entities within a selection volume who's lower corner is position in the world at min x/y/z and has the dimensions width/height/depth (length x, length y, length z respectively). This method ensures collection and iteration of the entities is carried out on the world thread.

Parameters:

world - The world in which the selection is made.

minX - The lower x-coordinate of the selection.

minY - The lower y-coordinate of the selection.

minZ - The lower z-coordinate of the selection.

width - The width (x-axis) of the selection.

height - The height (y-axis) of the selection.

depth - The depth (z-axis) of the selection.

action - The action to perform for each entity found.

getNewPathIdOnPrefabPasted

@Nonnull
public UUID getNewPathIdOnPrefabPasted(@Nullable
 UUID id,
 String name,
 int prefabId)

onPasteStart

public static boolean onPasteStart(int prefabId,
 @Nonnull
 ComponentAccessor<EntityStore> componentAccessor)

onPasteEnd

public void onPasteEnd(int prefabId,
 @Nonnull
 ComponentAccessor<EntityStore> componentAccessor)

getPastedPrefabPathUUIDMap

public com.hypixel.fastutil.ints.Int2ObjectConcurrentHashMap<ConcurrentHashMap<UUID,UUID>> getPastedPrefabPathUUIDMap()