Class BrushConfigCommandExecutor

java.lang.Object

com.hypixel.hytale.builtin.buildertools.scriptedbrushes.BrushConfigCommandExecutor

public class BrushConfigCommandExecutor
extends Object

Executes a brush config based on preconfigured commands

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	BrushConfigCommandExecutor.DebugOutputTarget

Constructor Summary

Constructors

Constructor	Description
BrushConfigCommandExecutor(BrushConfig brushConfig)

Method Summary

Modifier and Type	Method	Description
void	clearAllPersistentVariables()
void	clearPersistentVariable(String variableName)
void	execute(Ref<EntityStore> ref, World world, org.joml.Vector3i origin, boolean isHoldDownInteraction, InteractionType interactionType, ComponentAccessor<EntityStore> componentAccessor)
void	execute(Ref<EntityStore> ref, World world, org.joml.Vector3i origin, boolean isHoldDownInteraction, InteractionType interactionType, Consumer<BrushConfig> existingBrushDataLoadingConsumer, ComponentAccessor<EntityStore> componentAccessor)
void	exitExecution(Ref<EntityStore> ref, ComponentAccessor<EntityStore> componentAccessor)
int	getCurrentOperationIndex()
BrushConfigCommandExecutor.DebugOutputTarget	getDebugOutputTarget()
BrushConfigEditStore	getEdit()
Map<String, GlobalBrushOperation>	getGlobalOperations()
int	getPersistentVariableOrDefault(String variableName, int defaultValue)
List<SequenceBrushOperation>	getSequentialOperations()
boolean	isBreakOnError()
boolean	isEnableBreakpoints()
boolean	isIgnoreExistingBrushData()
boolean	isInDebugSteppingMode()
void	loadBrushConfigSnapshot(String name, BrushConfig.DataSettingFlags... dataToLoad)
void	loadOperatingIndex(String name)	Allows future jumping
void	loadOperatingIndex(String name, boolean allowFutureJump)
void	resetInternalState()
void	setAllowOverwritingSavedSnapshots(boolean allowOverwritingSavedSnapshots)
void	setBreakOnError(boolean breakOnError)
void	setCurrentlyExecutingActionIndex(int newCurrentOperationIndex)
void	setDebugOutputTarget(BrushConfigCommandExecutor.DebugOutputTarget debugOutputTarget)
void	setEnableBreakpoints(boolean enableBreakpoints)
void	setIgnoreExistingBrushData(boolean ignoreExistingBrushData)
void	setInDebugSteppingMode(boolean inDebugSteppingMode)
void	setPersistentVariable(String variableName, int value)
void	setPrintOperations(boolean printOperations)
BrushConfig.BCExecutionStatus	step(Ref<EntityStore> ref, boolean placePreviewAfterStep, ComponentAccessor<EntityStore> componentAccessor)	Perform a single step of this operation This method manages the internal state, such that this is safe to call whenever, as many times as you want
void	storeBrushConfigSnapshot(String name)
void	storeOperatingIndex(String name, int index)

Methods inherited from class Object

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

Constructor Details

BrushConfigCommandExecutor

public BrushConfigCommandExecutor(BrushConfig brushConfig)

Method Details

resetInternalState

public void resetInternalState()

execute

public void execute(@Nonnull
 Ref<EntityStore> ref,
 @Nonnull
 World world,
 @Nonnull
 org.joml.Vector3i origin,
 boolean isHoldDownInteraction,
 @Nonnull
 InteractionType interactionType,
 @Nullable
 Consumer<BrushConfig> existingBrushDataLoadingConsumer,
 @Nonnull
 ComponentAccessor<EntityStore> componentAccessor)

execute

public void execute(@Nonnull
 Ref<EntityStore> ref,
 World world,
 org.joml.Vector3i origin,
 boolean isHoldDownInteraction,
 InteractionType interactionType,
 ComponentAccessor<EntityStore> componentAccessor)

step

@Nonnull
public BrushConfig.BCExecutionStatus step(Ref<EntityStore> ref,
 boolean placePreviewAfterStep,
 ComponentAccessor<EntityStore> componentAccessor)

Perform a single step of this operation This method manages the internal state, such that this is safe to call whenever, as many times as you want

exitExecution

public void exitExecution(Ref<EntityStore> ref,
 ComponentAccessor<EntityStore> componentAccessor)

storeOperatingIndex

public void storeOperatingIndex(String name,
 int index)

loadOperatingIndex

public void loadOperatingIndex(String name)

Allows future jumping

loadOperatingIndex

public void loadOperatingIndex(String name,
 boolean allowFutureJump)

clearAllPersistentVariables

public void clearAllPersistentVariables()

clearPersistentVariable

public void clearPersistentVariable(String variableName)

setPersistentVariable

public void setPersistentVariable(String variableName,
 int value)

getPersistentVariableOrDefault

public int getPersistentVariableOrDefault(String variableName,
 int defaultValue)

storeBrushConfigSnapshot

public void storeBrushConfigSnapshot(@Nonnull
 String name)

loadBrushConfigSnapshot

public void loadBrushConfigSnapshot(String name,
 @Nonnull
 BrushConfig.DataSettingFlags... dataToLoad)

setAllowOverwritingSavedSnapshots

public void setAllowOverwritingSavedSnapshots(boolean allowOverwritingSavedSnapshots)

getSequentialOperations

@Nonnull
public List<SequenceBrushOperation> getSequentialOperations()

getGlobalOperations

@Nonnull
public Map<String, GlobalBrushOperation> getGlobalOperations()

isIgnoreExistingBrushData

public boolean isIgnoreExistingBrushData()

isInDebugSteppingMode

public boolean isInDebugSteppingMode()

getEdit

public BrushConfigEditStore getEdit()

setInDebugSteppingMode

public void setInDebugSteppingMode(boolean inDebugSteppingMode)

setPrintOperations

public void setPrintOperations(boolean printOperations)

setIgnoreExistingBrushData

public void setIgnoreExistingBrushData(boolean ignoreExistingBrushData)

setCurrentlyExecutingActionIndex

public void setCurrentlyExecutingActionIndex(int newCurrentOperationIndex)

getCurrentOperationIndex

public int getCurrentOperationIndex()

isEnableBreakpoints

public boolean isEnableBreakpoints()

setEnableBreakpoints

public void setEnableBreakpoints(boolean enableBreakpoints)

getDebugOutputTarget

public BrushConfigCommandExecutor.DebugOutputTarget getDebugOutputTarget()

setDebugOutputTarget

public void setDebugOutputTarget(BrushConfigCommandExecutor.DebugOutputTarget debugOutputTarget)

isBreakOnError

public boolean isBreakOnError()

setBreakOnError

public void setBreakOnError(boolean breakOnError)