Contents
- Description
- Nested Class Summary
- Constructor Summary
- Method Summary
- Constructor Details
- Method Details
- beginExecution(Vector3i, boolean, InteractionType)
- endExecution()
- resetToDefaultValues()
- isHoldDownInteraction()
- isCurrentlyExecuting()
- getInteractionType()
- getExecutionOrigin()
- getOrigin()
- getOriginOffset()
- setOriginOffset(Vector3i)
- modifyOriginOffset(Vector3i)
- updateOriginWithOffsets()
- getRandom()
- getNextBlock()
- getNextMaterial()
- getBlockMask()
- setOperationMask(BlockMask)
- appendOperationMask(BlockMask)
- clearOperationMask()
- setUseBrushMask(boolean)
- setUseOperationMask(boolean)
- setBrushMask(BlockMask)
- getDensity()
- setDensity(int)
- getHistoryMask()
- setHistoryMask(BrushConfig.HistoryMask)
- getShapeWidth()
- setShapeWidth(int)
- getShapeHeight()
- setShapeHeight(int)
- getShapeThickness()
- setShapeThickness(int)
- getTransformOrigin()
- setTransformOrigin(Vector3i)
- getTransform()
- setTransform(Transform)
- resetTransform()
- isCapped()
- setCapped(boolean)
- getShape()
- setShape(BrushShape)
- getPattern()
- setPattern(BlockPattern)
- setErrorFlag(String)
- clearError()
- isHasExecutionContextEncounteredError()
- getExecutionErrorMessage()
- getOriginAfterOffset()
- toString()
- getInfo()
Class BrushConfig
java.lang.Object
com.hypixel.hytale.builtin.buildertools.scriptedbrushes.BrushConfig
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumstatic enumstatic enumstatic enum -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidappendOperationMask(BlockMask mask) voidbeginExecution(org.joml.Vector3i origin, boolean isHoldDownInteraction, InteractionType interactionType) voidvoidvoidintorg.joml.Vector3igetInfo()intGets the next material from the pattern.org.joml.Vector3iorg.joml.Vector3iorg.joml.Vector3igetShape()intintintorg.joml.Vector3ibooleanisCapped()booleanbooleanbooleanvoidmodifyOriginOffset(org.joml.Vector3i originOffsetOffset) voidvoidvoidsetBrushMask(BlockMask mask) Note: This should only be used when creating the brushconfigvoidsetCapped(boolean capped) voidsetDensity(int density) voidsetErrorFlag(String errorMessage) voidsetHistoryMask(BrushConfig.HistoryMask historyMask) voidsetOperationMask(BlockMask mask) voidsetOriginOffset(org.joml.Vector3i originOffset) voidsetPattern(BlockPattern pattern) voidsetShape(BrushShape shape) voidsetShapeHeight(int shapeHeight) voidsetShapeThickness(int shapeThickness) voidsetShapeWidth(int shapeWidth) voidsetTransform(Transform transform) voidsetTransformOrigin(org.joml.Vector3i transformOrigin) voidsetUseBrushMask(boolean useBrushMask) voidsetUseOperationMask(boolean useOperationMask) toString()void
-
Constructor Details
-
BrushConfig
public BrushConfig() -
BrushConfig
-
-
Method Details
-
beginExecution
public void beginExecution(org.joml.Vector3i origin, boolean isHoldDownInteraction, InteractionType interactionType) -
endExecution
public void endExecution() -
resetToDefaultValues
public void resetToDefaultValues() -
isHoldDownInteraction
public boolean isHoldDownInteraction() -
isCurrentlyExecuting
public boolean isCurrentlyExecuting() -
getInteractionType
-
getExecutionOrigin
@Nullable public org.joml.Vector3i getExecutionOrigin() -
getOrigin
@Nullable public org.joml.Vector3i getOrigin() -
getOriginOffset
@Nonnull public org.joml.Vector3i getOriginOffset() -
setOriginOffset
public void setOriginOffset(org.joml.Vector3i originOffset) -
modifyOriginOffset
public void modifyOriginOffset(@Nonnull org.joml.Vector3i originOffsetOffset) -
updateOriginWithOffsets
public void updateOriginWithOffsets() -
getRandom
-
getNextBlock
public int getNextBlock() -
getNextMaterial
Gets the next material from the pattern.This method determines whether the pattern contains fluid items or blocks and returns the appropriate Material. Operations should use this instead of checking isFluidPattern() separately.
- Returns:
- the next material from the pattern (block or fluid)
-
getBlockMask
-
setOperationMask
-
appendOperationMask
-
clearOperationMask
public void clearOperationMask() -
setUseBrushMask
public void setUseBrushMask(boolean useBrushMask) -
setUseOperationMask
public void setUseOperationMask(boolean useOperationMask) -
setBrushMask
Note: This should only be used when creating the brushconfig -
getDensity
public int getDensity() -
setDensity
public void setDensity(int density) -
getHistoryMask
-
setHistoryMask
-
getShapeWidth
public int getShapeWidth() -
setShapeWidth
public void setShapeWidth(int shapeWidth) -
getShapeHeight
public int getShapeHeight() -
setShapeHeight
public void setShapeHeight(int shapeHeight) -
getShapeThickness
public int getShapeThickness() -
setShapeThickness
public void setShapeThickness(int shapeThickness) -
getTransformOrigin
public org.joml.Vector3i getTransformOrigin() -
setTransformOrigin
public void setTransformOrigin(org.joml.Vector3i transformOrigin) -
getTransform
-
setTransform
-
resetTransform
public void resetTransform() -
isCapped
public boolean isCapped() -
setCapped
public void setCapped(boolean capped) -
getShape
-
setShape
-
getPattern
-
setPattern
-
setErrorFlag
-
clearError
public void clearError() -
isHasExecutionContextEncounteredError
public boolean isHasExecutionContextEncounteredError() -
getExecutionErrorMessage
-
getOriginAfterOffset
@Nullable public org.joml.Vector3i getOriginAfterOffset() -
toString
-
getInfo
-