Class BrushOperation

java.lang.Object

com.hypixel.hytale.builtin.buildertools.scriptedbrushes.operations.system.BrushOperation

Direct Known Subclasses:

GlobalBrushOperation, SequenceBrushOperation

public abstract class BrushOperation
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final Map<String, Supplier<BrushOperation>>	BRUSH_OPERATION_REGISTRY
static final CodecMapCodec<BrushOperation>	OPERATION_CODEC	Polymorphic codec map for all brush operations, allowing serialization/deserialization of different operation types.

Constructor Summary

Constructors

Constructor	Description
BrushOperation(String name, String description)

Method Summary

Modifier and Type	Method	Description
<T> BrushOperationSetting<T>	createBrushSetting(String name, String description, T defaultValue, ArgumentType<T> argumentType)
<T> BrushOperationSetting<T>	createBrushSetting(String name, String description, T defaultValue, ArgumentType<T> argumentType, Function<BrushOperationSetting<T>, String> toStringFunction)
String	getDescription()
String	getName()
Map<String, BrushOperationSetting<?>>	getRegisteredOperationSettings()
abstract void	modifyBrushConfig(Ref<EntityStore> ref, BrushConfig brushConfig, BrushConfigCommandExecutor brushConfigCommandExecutor, ComponentAccessor<EntityStore> componentAccessor)
void	preExecutionModifyBrushConfig(BrushConfigCommandExecutor brushConfigCommandExecutor, int operationIndex)
void	resetInternalState()

Methods inherited from class Object

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

Field Details

OPERATION_CODEC

public static final CodecMapCodec<BrushOperation> OPERATION_CODEC

Polymorphic codec map for all brush operations, allowing serialization/deserialization of different operation types. Operations should be registered here using their ID and codec.

BRUSH_OPERATION_REGISTRY

public static final Map<String, Supplier<BrushOperation>> BRUSH_OPERATION_REGISTRY

Constructor Details

BrushOperation

public BrushOperation(String name,
 String description)

Method Details

modifyBrushConfig

public abstract void modifyBrushConfig(@Nonnull
 Ref<EntityStore> ref,
 @Nonnull
 BrushConfig brushConfig,
 @Nonnull
 BrushConfigCommandExecutor brushConfigCommandExecutor,
 @Nonnull
 ComponentAccessor<EntityStore> componentAccessor)

resetInternalState

public void resetInternalState()

preExecutionModifyBrushConfig

public void preExecutionModifyBrushConfig(BrushConfigCommandExecutor brushConfigCommandExecutor,
 int operationIndex)

Parameters:

brushConfigCommandExecutor - the executor that is running this operation

operationIndex - the current index that this operation exists at, useful for jumps initialization

createBrushSetting

@Nonnull
public <T> BrushOperationSetting<T> createBrushSetting(@Nonnull
 String name,
 String description,
 T defaultValue,
 ArgumentType<T> argumentType)

createBrushSetting

@Nonnull
public <T> BrushOperationSetting<T> createBrushSetting(@Nonnull
 String name,
 String description,
 T defaultValue,
 ArgumentType<T> argumentType,
 Function<BrushOperationSetting<T>, String> toStringFunction)

getName

public String getName()

getDescription

public String getDescription()

getRegisteredOperationSettings

@Nonnull
public Map<String, BrushOperationSetting<?>> getRegisteredOperationSettings()