Class BrushConfig

java.lang.Object
com.hypixel.hytale.builtin.buildertools.scriptedbrushes.BrushConfig

public class BrushConfig extends Object
  • Constructor Details

    • BrushConfig

      public BrushConfig()
    • BrushConfig

      public BrushConfig(@Nonnull BrushConfig other)
  • 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

      @Nullable public InteractionType 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

      @Nonnull public Random getRandom()
    • getNextBlock

      public int getNextBlock()
    • getNextMaterial

      @Nonnull public Material 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

      public BlockMask getBlockMask()
    • setOperationMask

      public void setOperationMask(BlockMask mask)
    • appendOperationMask

      public void appendOperationMask(BlockMask mask)
    • clearOperationMask

      public void clearOperationMask()
    • setUseBrushMask

      public void setUseBrushMask(boolean useBrushMask)
    • setUseOperationMask

      public void setUseOperationMask(boolean useOperationMask)
    • setBrushMask

      public void setBrushMask(BlockMask mask)
      Note: This should only be used when creating the brushconfig
    • getDensity

      public int getDensity()
    • setDensity

      public void setDensity(int density)
    • getHistoryMask

      public BrushConfig.HistoryMask getHistoryMask()
    • setHistoryMask

      public void setHistoryMask(BrushConfig.HistoryMask historyMask)
    • 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

      public Transform getTransform()
    • setTransform

      public void setTransform(Transform transform)
    • resetTransform

      public void resetTransform()
    • isCapped

      public boolean isCapped()
    • setCapped

      public void setCapped(boolean capped)
    • getShape

      public BrushShape getShape()
    • setShape

      public void setShape(BrushShape shape)
    • getPattern

      public BlockPattern getPattern()
    • setPattern

      public void setPattern(BlockPattern pattern)
    • setErrorFlag

      public void setErrorFlag(String errorMessage)
    • clearError

      public void clearError()
    • isHasExecutionContextEncounteredError

      public boolean isHasExecutionContextEncounteredError()
    • getExecutionErrorMessage

      @Nullable public String getExecutionErrorMessage()
    • getOriginAfterOffset

      @Nullable public org.joml.Vector3i getOriginAfterOffset()
    • toString

      @Nonnull public String toString()
      Overrides:
      toString in class Object
    • getInfo

      @Nonnull public String getInfo()