HytaleDocs

ScriptedBrushes

Asset path: Server/ScriptedBrushes/*.json

A scripted brush asset containing multiple brush operations that will be executed sequentially

Parent

When set this asset will inherit properties from the named asset.

When inheriting from another ScriptedBrushAsset most properties will simply be copied from the parent asset to this asset. In the case where both child and parent provide a field the child field will simply replace the value provided by the parent, in the case of nested structures this will apply to the fields within the structure. In some cases the field may decide to act differently, for example: by merging the parent and child fields together.

Type information: String

Tags

Tags are a general way to describe an asset that can be interpreted by other systems in a way they see fit.

For example you could tag something with a Material tag with the values Solid and Stone, And another single tag Ore.

Tags will be expanded into a single list of tags automatically. Using the above example with Material and Ore the end result would be the following list of tags: Ore, Material, Solid, Stone, Material=Solid and Material=Stone.

Type information:

(Nullable) Map of the following:

KeyType
any StringArray of String

Operations

The list of brush operations to execute sequentially

Type information:

(Nullable) Array of the type: Any of these:

Key: IdType
appendmask

Append new masks to the current operation mask

AppendMaskOperation

AppendMaskOperation with the following properties:

KeyTypeDescription
IdConstant value: appendmask

This field controls the type, it must be set to the constant value "appendmask" to function as this type.

AppendMask(Nullable) String

Combines the new mask with the current operation mask

appendmaskfromtoolarg

Append a mask from a Block tool arg with configurable filter type and optional additional blocks

AppendMaskFromToolArgOperation

AppendMaskFromToolArgOperation with the following properties:

KeyTypeDescription
IdConstant value: appendmaskfromtoolarg

This field controls the type, it must be set to the constant value "appendmaskfromtoolarg" to function as this type.

ArgName(Nullable) String defaults to:

The name of the Block tool arg to read the material from

FilterType(Nullable) FilterType

The type of block filter mask to apply (e.g., TARGET_BLOCK, ABOVE_BLOCK, BELOW_BLOCK)

InvertBoolean defaults to: false

Whether to invert the block filter mask or not

AdditionalBlocks(Nullable) String

Additional block names to append to the mask, comma separated (e.g., Rock_Stone,Rock_Granite)

breakpoint

Debug breakpoint for scripted brushes

BreakpointOperation

BreakpointOperation with the following properties:

KeyTypeDescription
IdConstant value: breakpoint

This field controls the type, it must be set to the constant value "breakpoint" to function as this type.

Label(Nullable) String defaults to:

Identifier for this breakpoint

PrintMessageBoolean defaults to: false

Print a message when breakpoint is reached

PrintStateBoolean defaults to: false

Print brush state when breakpoint is reached

EnterStepModeBoolean defaults to: false

Enter step-through mode (use /sb step to continue)

Condition(Nullable) BrushConfigIntegerComparison

Optional condition - breakpoint only triggers if condition passes

clearoperationmask

Reset the Brush-Config-provided mask to nothing, keeping the brush tool's mask

ClearOperationMaskOperation

ClearOperationMaskOperation with the following properties:

KeyTypeDescription
IdConstant value: clearoperationmask

This field controls the type, it must be set to the constant value "clearoperationmask" to function as this type.

clearrotation

Reset the Brush-Config-provided rotation settings to default to undo the rotations

ClearRotationOperation

ClearRotationOperation with the following properties:

KeyTypeDescription
IdConstant value: clearrotation

This field controls the type, it must be set to the constant value "clearrotation" to function as this type.

debug

Debug options for scripted brushes

DebugBrushOperation

DebugBrushOperation with the following properties:

KeyTypeDescription
IdConstant value: debug

This field controls the type, it must be set to the constant value "debug" to function as this type.

PrintOperationsBoolean defaults to: false

Prints the index and name of each operation as it executes

StepThroughBoolean defaults to: false

Enables manual step-through mode (pause after each operation)

EnableBreakpointsBoolean defaults to: false

Master toggle for breakpoint operations

OutputTarget(Nullable) DebugOutputTarget

Where debug messages are sent (Chat, Console, or Both)

BreakOnErrorBoolean defaults to: false

Pause on error instead of terminating execution

delete

Remove all blocks and fluids in the area

DeleteOperation

DeleteOperation with the following properties:

KeyTypeDescription
IdConstant value: delete

This field controls the type, it must be set to the constant value "delete" to function as this type.

density

Sets the random chance that any given block being set will actually get set, otherwise getting cancelled. Ex: a value of 30 is a 30% chance blocks will appear with a set operation.

SetDensity

SetDensity with the following properties:

KeyTypeDescription
IdConstant value: density

This field controls the type, it must be set to the constant value "density" to function as this type.

DensityInteger defaults to: 100

Changes the likelyhood that a given block will be processed

dimensions

Set, add, or subtract from the dimensions of the brush area

DimensionsOperation

DimensionsOperation with the following properties:

KeyTypeDescription
IdConstant value: dimensions

This field controls the type, it must be set to the constant value "dimensions" to function as this type.

Width(Nullable) RelativeInteger

Sets the width of the brush to the specified amount, optionally relative to the existing amount when using prefixing with tilde

Height(Nullable) RelativeInteger

Sets the height of the brush to the specified amount, optionally relative to the existing amount when using prefixing with tilde

disableonhold

Disables the ability of the brush to activate multiple times on holding a button

DisableHoldInteractionOperation

DisableHoldInteractionOperation with the following properties:

KeyTypeDescription
IdConstant value: disableonhold

This field controls the type, it must be set to the constant value "disableonhold" to function as this type.

echo

Print some text to chat

EchoOperation

EchoOperation with the following properties:

KeyTypeDescription
IdConstant value: echo

This field controls the type, it must be set to the constant value "echo" to function as this type.

Message(Nullable) String defaults to: Default message

A message to print to chat when this operation is ran

echoonce

Print text to chat only on the first execution after brush load

EchoOnceOperation

EchoOnceOperation with the following properties:

KeyTypeDescription
IdConstant value: echoonce

This field controls the type, it must be set to the constant value "echoonce" to function as this type.

Message(Nullable) String defaults to: Default message

A message to print to chat when this operation is first executed

erode

Erodes blocks following a preset

ErodeOperation

ErodeOperation with the following properties:

KeyTypeDescription
IdConstant value: erode

This field controls the type, it must be set to the constant value "erode" to function as this type.

ErodePreset(Nullable) ErodePreset

An erosion preset to use with the operation

exit

Exit the execution of the stack

ExitOperation

ExitOperation with the following properties:

KeyTypeDescription
IdConstant value: exit

This field controls the type, it must be set to the constant value "exit" to function as this type.

fluidfix

Fixes or clears fluids in the brush area after terrain modifications

FluidFixOperation

FluidFixOperation with the following properties:

KeyTypeDescription
IdConstant value: fluidfix

This field controls the type, it must be set to the constant value "fluidfix" to function as this type.

FluidAction(Nullable) FluidAction

Fill flood-fills fluids into air pockets. Clear removes all fluids in the brush area.

heightmaplayer

Replace blocks according to the specified layers in terms of their depth from the tallest block in its column

HeightmapLayerOperation

HeightmapLayerOperation with the following properties:

KeyTypeDescription
IdConstant value: heightmaplayer

This field controls the type, it must be set to the constant value "heightmaplayer" to function as this type.

Layers(Nullable) Array of the type: LayerEntryCodec

The layers to set

historymask

Sets the history mask, allowing you to mask to previously edited or non-edited blocks

HistoryMaskOperation

HistoryMaskOperation with the following properties:

KeyTypeDescription
IdConstant value: historymask

This field controls the type, it must be set to the constant value "historymask" to function as this type.

HistoryMask(Nullable) HistoryMask

Changes the mask to block history, enable only history, or ignore history

ignorebrushsettings

Ignores any existing brush settings specified on the tool

IgnoreExistingBrushDataOperation

IgnoreExistingBrushDataOperation with the following properties:

KeyTypeDescription
IdConstant value: ignorebrushsettings

This field controls the type, it must be set to the constant value "ignorebrushsettings" to function as this type.

jump

Jump the stack execution to the point in the stack of the given saved index name

JumpToIndexOperation

JumpToIndexOperation with the following properties:

KeyTypeDescription
IdConstant value: jump

This field controls the type, it must be set to the constant value "jump" to function as this type.

StoredIndexName(Nullable) String defaults to: Undefined

The labeled index to jump to, previous or future

jumpifblocktype

Jump the execution of the stack based on a block type comparison

JumpIfBlockTypeOperation

JumpIfBlockTypeOperation with the following properties:

KeyTypeDescription
IdConstant value: jumpifblocktype

This field controls the type, it must be set to the constant value "jumpifblocktype" to function as this type.

Mask(Nullable) String

The block mask for the comparison.

StoredIndexName(Nullable) String defaults to: Undefined

The labeled index to jump to, previous or future

jumpifclicktype

Jump the execution of the stack based on the click type

JumpIfClickType

JumpIfClickType with the following properties:

KeyTypeDescription
IdConstant value: jumpifclicktype

This field controls the type, it must be set to the constant value "jumpifclicktype" to function as this type.

StoredIndexName(Nullable) String defaults to: Undefined

The labeled index to jump to, previous or future

ClickType(Nullable) ClickType

The click type (left or right) to compare with to jump

jumpifcompare

Jump stack execution to a stored index operation based on a specified conditional using the brush config data

JumpIfCompareOperation

JumpIfCompareOperation with the following properties:

KeyTypeDescription
IdConstant value: jumpifcompare

This field controls the type, it must be set to the constant value "jumpifcompare" to function as this type.

Comparisons(Nullable) Array of the type: BrushConfigIntegerComparison

The comparison(s) that will be executed using AND between them to see if you should jump or not

StoredIndexName(Nullable) String defaults to: Undefined

The labeled index to jump to, previous or future

jumpifequal

Jump the execution of the stack to the stored point if a string matches, useful for macro commands.

JumpIfStringMatchOperation

JumpIfStringMatchOperation with the following properties:

KeyTypeDescription
IdConstant value: jumpifequal

This field controls the type, it must be set to the constant value "jumpifequal" to function as this type.

StoredIndexName(Nullable) String defaults to: Undefined

The labeled index to jump to, previous or future

LeftSideOfStatement(Nullable) String defaults to: Undefined

The left side of the statement for checking case-insensitive equals

RightSideOfStatement(Nullable) String defaults to: Undefined

The right side of the statement for checking case-insensitive equals

jumpiftoolarg

Jump stack execution based on a builder tool argument comparison (supports checkbox/bool and dropdown/option types)

JumpIfToolArgOperation

JumpIfToolArgOperation with the following properties:

KeyTypeDescription
IdConstant value: jumpiftoolarg

This field controls the type, it must be set to the constant value "jumpiftoolarg" to function as this type.

ArgName(Nullable) String defaults to:

The name of the tool arg to compare

ComparisonType(Nullable) ComparisonType

The type of comparison to perform

ComparisonValue(Nullable) String defaults to:

The value to compare against (for boolean: 'true' or 'false', for string: the exact string or dropdown option)

StoredIndexName(Nullable) String defaults to: Undefined

The labeled index to jump to, previous or future

jumprandom

Jump the stack execution to a random location in the stack using the specified weights and saved index names

JumpToRandomIndex

JumpToRandomIndex with the following properties:

KeyTypeDescription
IdConstant value: jumprandom

This field controls the type, it must be set to the constant value "jumprandom" to function as this type.

WeightedListOfIndexNames(Nullable) Array of the type: IntegerStringPair

A weighted list of weights and their corresponding index names

kernelsmooth

Smooths terrain using weighted kernels with erosion thresholds

KernelErosionOperation

KernelErosionOperation with the following properties:

KeyTypeDescription
IdConstant value: kernelsmooth

This field controls the type, it must be set to the constant value "kernelsmooth" to function as this type.

Kernel(Nullable) SmoothKernel

The smoothing kernel shape to use

Mode(Nullable) SmoothMode

Smoothing mode: Full (3D), Heightmap (2D heightmap), or Flat (XZ-plane only)

ErosionStrengthInteger defaults to: 0

Erosion strength from -10 to 10 (divided by 10 internally). Positive erodes, negative fills.

SampleNearbyBoolean defaults to: false

When true, samples neighbor block types for fill material. When false, uses the brush pattern.

layer

Replace blocks according to the specified layers in terms of their depth from the nearest air block

LayerOperation

LayerOperation with the following properties:

KeyTypeDescription
IdConstant value: layer

This field controls the type, it must be set to the constant value "layer" to function as this type.

Layers(Nullable) Array of the type: LayerEntryCodec

The layers to set

lift

Lift all blocks up by one (duplicating the block) that are touching air, preserving the material

LiftOperation

LiftOperation with the following properties:

KeyTypeDescription
IdConstant value: lift

This field controls the type, it must be set to the constant value "lift" to function as this type.

loadbrushconfig

Restore a saved brush config snapshot

LoadBrushConfigOperation

LoadBrushConfigOperation with the following properties:

KeyTypeDescription
IdConstant value: loadbrushconfig

This field controls the type, it must be set to the constant value "loadbrushconfig" to function as this type.

StoredName(Nullable) String defaults to: Undefined

The name to store the snapshot of this brush config under

ParametersToLoad(Nullable) Array of the type: DataSettingFlags

A list of the different parameters to load from the stored config

loadint

Load an integer from an Int tool arg and apply it to a brush config field

LoadIntFromToolArgOperation

LoadIntFromToolArgOperation with the following properties:

KeyTypeDescription
IdConstant value: loadint

This field controls the type, it must be set to the constant value "loadint" to function as this type.

ArgName(Nullable) String defaults to:

The name of the Int tool arg to load the value from

TargetField(Nullable) TargetField

The brush config field to set (Width, Height, Density, Thickness, OffsetX, OffsetY, OffsetZ)

RelativeBoolean defaults to: false

When true, adds the loaded value to the current field value instead of replacing it

NegateBoolean defaults to: false

When true, turns the sign of the value to negative

loadloop

Loop the execution of instructions a set amount of times

LoadLoopFromToolArgOperation

LoadLoopFromToolArgOperation with the following properties:

KeyTypeDescription
IdConstant value: loadloop

This field controls the type, it must be set to the constant value "loadloop" to function as this type.

StoredIndexName(Nullable) String defaults to: Undefined

The name of the previously stored index to begin the loop at. Note: This can only be an index previous to the current.

ArgName(Nullable) String defaults to:

The amount of additional times to repeat the loop after the initial, normal execution

loadmaterial

Load a block pattern from a Block tool arg and set it as the brush material

LoadMaterialFromToolArgOperation

LoadMaterialFromToolArgOperation with the following properties:

KeyTypeDescription
IdConstant value: loadmaterial

This field controls the type, it must be set to the constant value "loadmaterial" to function as this type.

ArgName(Nullable) String defaults to:

The name of the Block tool arg to load the material pattern from

loadoperationsfromasset

Load and inline operations from another ScriptedBrushAsset

LoadOperationsFromAssetOperation

LoadOperationsFromAssetOperation with the following properties:

KeyTypeDescription
IdConstant value: loadoperationsfromasset

This field controls the type, it must be set to the constant value "loadoperationsfromasset" to function as this type.

AssetId(Nullable) String defaults to:

The ID of the ScriptedBrushAsset to load operations from

loop

Loop the execution of instructions a set amount of times

LoopOperation

LoopOperation with the following properties:

KeyTypeDescription
IdConstant value: loop

This field controls the type, it must be set to the constant value "loop" to function as this type.

StoredIndexName(Nullable) String defaults to: Undefined

The name of the previously stored index to begin the loop at. Note: This can only be an index previous to the current.

AdditionalRepetitionsInteger defaults to: 0

The amount of additional times to repeat the loop after the initial, normal execution

loopcircle

Loops specified instructions and changes the offset after each loop in order to execute around a circle

CircleOffsetAndLoopOperation

CircleOffsetAndLoopOperation with the following properties:

KeyTypeDescription
IdConstant value: loopcircle

This field controls the type, it must be set to the constant value "loopcircle" to function as this type.

StoredIndexName(Nullable) String defaults to: Undefined

The name of the previously stored index to begin the loop at. Note: This can only be an index previous to the current.

NumberOfCirclePointsInteger defaults to: 3

The amount of equidistant points on the circle to loop at

CircleRadiusInteger defaults to: 5

The radius of the circle

FlipDirectionBoolean defaults to: false

Whether to invert the direction of the circle. Useful for non-zero offset modifiers.

RotateDirectionBoolean defaults to: false

Whether to invert the direction of the circle. Useful for non-zero offset modifiers.

loopcirclefromarg
CircleOffsetFromArgOperation

CircleOffsetFromArgOperation with the following properties:

KeyTypeDescription
IdConstant value: loopcirclefromarg

This field controls the type, it must be set to the constant value "loopcirclefromarg" to function as this type.

StoredIndexName(Nullable) String defaults to: Undefined

The name of the previously stored index to begin the loop at. Note: This can only be an index previous to the current.

NumberCirclePointsArg(Nullable) String defaults to:

The name of the Int tool arg to load the value from

CircleRadiusArg(Nullable) String defaults to:

The name of the Int tool arg to load the value from

FlipDirectionBoolean defaults to: false

Whether to invert the direction of the circle. Useful for non-zero offset modifiers.

RotateDirectionBoolean defaults to: false

Whether to invert the direction of the circle. Useful for non-zero offset modifiers.

looprandom

Loop the execution of instructions a random amount of times

LoopRandomOperation

LoopRandomOperation with the following properties:

KeyTypeDescription
IdConstant value: looprandom

This field controls the type, it must be set to the constant value "looprandom" to function as this type.

StoredIndexName(Nullable) String defaults to: Undefined

The name of the previously stored index to begin the loop at. Note: This can only be an index previous to the current.

RangeOfAdditionalRepetitions(Nullable) IntegerPair

The minimum and maximum of a range, randomly choosing the amount of additional times to repeat the loop after the initial, normal execution

mask

Sets the operation mask to only modify blocks that match the mask

MaskOperation

MaskOperation with the following properties:

KeyTypeDescription
IdConstant value: mask

This field controls the type, it must be set to the constant value "mask" to function as this type.

Mask(Nullable) String

Sets the operation mask

material

Change the brush's material

MaterialOperation

MaterialOperation with the following properties:

KeyTypeDescription
IdConstant value: material

This field controls the type, it must be set to the constant value "material" to function as this type.

BlockType(Nullable) String defaults to: Rock_Stone

A single material to set the block type to. You can also use Block Pattern operation to set a pattern of blocks

melt

Remove the top layer of blocks in the brush editing area

MeltOperation

MeltOperation with the following properties:

KeyTypeDescription
IdConstant value: melt

This field controls the type, it must be set to the constant value "melt" to function as this type.

offset

Offset the brush location by a specified amount from the clicked origin

OffsetOperation

OffsetOperation with the following properties:

KeyTypeDescription
IdConstant value: offset

This field controls the type, it must be set to the constant value "offset" to function as this type.

Offset(Nullable) RelativeVector3i

Sets the offset in 3 dimensions, each value is optionally relative by prefixing it with a tilde

TargetField(Nullable) TargetField (1)

The brush config field to set (Width, Height, Density, Thickness, OffsetX, OffsetY, OffsetZ)

NegateBoolean defaults to: false

Whether to invert the sign of the relative field

pasteprefab

Paste a prefab at the origin+offset point

PastePrefabOperation

PastePrefabOperation with the following properties:

KeyTypeDescription
IdConstant value: pasteprefab

This field controls the type, it must be set to the constant value "pasteprefab" to function as this type.

PrefabListAssetName(Nullable) String

The name of a PrefabList asset

pattern

Change the material of the brush to a pattern of blocks

BlockPatternOperation

BlockPatternOperation with the following properties:

KeyTypeDescription
IdConstant value: pattern

This field controls the type, it must be set to the constant value "pattern" to function as this type.

BlockPattern(Nullable) String

The pattern of blocks to use in your set

persistentdata

Store and operate on data that sticks around between executions

PersistentDataOperation

PersistentDataOperation with the following properties:

KeyTypeDescription
IdConstant value: persistentdata

This field controls the type, it must be set to the constant value "persistentdata" to function as this type.

StoredName(Nullable) String defaults to: Undefined

The name of the variable to modify

Operation(Nullable) IntegerOperation

The operation to perform on the variable using the modifier

ModifierInteger defaults to: 0

The value to modify the variable by

randomdimensions

Randomize the dimensions of the brush area

RandomizeDimensionsOperation

RandomizeDimensionsOperation with the following properties:

KeyTypeDescription
IdConstant value: randomdimensions

This field controls the type, it must be set to the constant value "randomdimensions" to function as this type.

WidthRange(Nullable) RelativeIntegerRange

The range of values for the width, optionally relative using tilde

HeightRange(Nullable) RelativeIntegerRange

The range of values for the height, optionally relative using tilde

randomoffset

Randomly offset the brush location from the clicked origin

RandomOffsetOperation

RandomOffsetOperation with the following properties:

KeyTypeDescription
IdConstant value: randomoffset

This field controls the type, it must be set to the constant value "randomoffset" to function as this type.

XOffsetRange(Nullable) RelativeIntegerRange

The range of allowed values for the X offset

YOffsetRange(Nullable) RelativeIntegerRange

The range of allowed values for the Z offset

ZOffsetRange(Nullable) RelativeIntegerRange

The range of allowed values for the Y offset

replace

Replace one kind of block with another pattern of blocks within the current brush editing area

ReplaceOperation

ReplaceOperation with the following properties:

KeyTypeDescription
IdConstant value: replace

This field controls the type, it must be set to the constant value "replace" to function as this type.

FromBlockType(Nullable) String defaults to: Rock_Stone

The block type to get replaced

ToBlockPattern(Nullable) String

The pattern of blocks set to

rotation

Rotates the brush based on axis, angle, and origin

RotateOperation

RotateOperation with the following properties:

KeyTypeDescription
IdConstant value: rotation

This field controls the type, it must be set to the constant value "rotation" to function as this type.

RotationAxis(Nullable) BrushAxis
RotationAngle(Nullable) Rotation
RotationOrigin(Nullable) RotationOrigin
runcommand

Runs a command, see help for argument replacements

RunCommandOperation

RunCommandOperation with the following properties:

KeyTypeDescription
IdConstant value: runcommand

This field controls the type, it must be set to the constant value "runcommand" to function as this type.

CommandToRun(Nullable) String defaults to:

Runs a command, substituting the strings... '{x}', '{y}', and '{z}' for the origin coordinates '{radius}' with width/2, '{width}' with width, and '{height}' with height '{var:} with the value of the persistent variable'

savebrushconfig

Save a snapshot of the current brush config in order to restore it later

SaveBrushConfigOperation

SaveBrushConfigOperation with the following properties:

KeyTypeDescription
IdConstant value: savebrushconfig

This field controls the type, it must be set to the constant value "savebrushconfig" to function as this type.

StoredName(Nullable) String defaults to: Undefined

The name to store the snapshot of this brush config under

saveindex

Mark this spot in the stack in order to loop or jump to it

SaveIndexOperation

SaveIndexOperation with the following properties:

KeyTypeDescription
IdConstant value: saveindex

This field controls the type, it must be set to the constant value "saveindex" to function as this type.

StoredIndexName(Nullable) String defaults to: Undefined

The name to store the current execution index at

set

Runs a 'set' operation using the parameters of the brush configuration. Supports both blocks and fluids - if the pattern contains fluid items, it sets the fluid layer instead.

SetOperation

SetOperation with the following properties:

KeyTypeDescription
IdConstant value: set

This field controls the type, it must be set to the constant value "set" to function as this type.

shape

Changes the shape of the brush editing area

ShapeOperation

ShapeOperation with the following properties:

KeyTypeDescription
IdConstant value: shape

This field controls the type, it must be set to the constant value "shape" to function as this type.

Shape(Nullable) BrushShape

Changes the brush shape

smooth

Smooths the blocks within the brush area as to make the area more natural looking

SmoothOperation

SmoothOperation with the following properties:

KeyTypeDescription
IdConstant value: smooth

This field controls the type, it must be set to the constant value "smooth" to function as this type.

SmoothStrengthInteger defaults to: 2

The strength of smoothing

usebrushmask

Enable the brush tool's mask (the mask placed on the tool)

UseBrushMaskOperation

UseBrushMaskOperation with the following properties:

KeyTypeDescription
IdConstant value: usebrushmask

This field controls the type, it must be set to the constant value "usebrushmask" to function as this type.

UseBrushMaskBoolean defaults to: true

Enables or disables the brush's mask

useoperationmask

Enable or disable the use of the operation mask

UseOperationMaskOperation

UseOperationMaskOperation with the following properties:

KeyTypeDescription
IdConstant value: useoperationmask

This field controls the type, it must be set to the constant value "useoperationmask" to function as this type.

UseOperationMaskBoolean defaults to: true

Enables or disables the operation mask

Notes:

Types referenced by this type

FilterType

(Nullable) Any one of the following String (defaults to TargetBlock):

NameDescription
"TargetBlock"
"AboveBlock"
"BelowBlock"
"AdjacentBlock"
"NeighborBlock"
"NorthBlock"
"EastBlock"
"SouthBlock"
"WestBlock"
"DiagonalXy"
"DiagonalXz"
"DiagonalZy"
"Selection"

DebugOutputTarget

(Nullable) Any one of the following String (defaults to Chat):

NameDescription
"Chat"
"Console"
"Both"

ErodePreset

(Nullable) Any one of the following String (defaults to Default):

NameDescription
"Default"
"Melt"
"Fill"
"Smooth"
"Lift"
"FloatClean"

FluidAction

(Nullable) Any one of the following String (defaults to Fill):

NameDescription
"Fill"
"Clear"

HistoryMask

(Nullable) Any one of the following String (defaults to None):

NameDescription
"None"
"Only"
"Not"

ClickType

(Nullable) Any one of the following String (defaults to Left):

NameDescription
"Left"
"Right"

ComparisonType

(Nullable) Any one of the following String (defaults to Equals):

NameDescription
"Equals"
"NotEquals"
"Contains"

SmoothKernel

(Nullable) Any one of the following String (defaults to Normal):

NameDescription
"Normal"
"Uniform"
"Gaussian"
"Neighbor"
"Square"

SmoothMode

(Nullable) Any one of the following String (defaults to Full):

NameDescription
"Full"
"Heightmap"
"Flat"

DataSettingFlags

Any one of the following String:

NameDescription
"Offset"
"Shape"
"Dimensions"
"Thickness"
"Capped"
"Transform"
"Pattern"
"Density"
"BrushMask"
"OperationMask"
"HistoryMask"

TargetField

(Nullable) Any one of the following String (defaults to Width):

NameDescription
"None"
"Width"
"Height"
"Density"
"Thickness"
"OffsetX"
"OffsetY"
"OffsetZ"

TargetField (1)

(Nullable) Any one of the following String (defaults to None):

NameDescription
"None"
"Width"
"Height"
"Density"
"Thickness"
"OffsetX"
"OffsetY"
"OffsetZ"

IntegerOperation

(Nullable) Any one of the following String (defaults to Set):

NameDescription
"Add"
"Subtract"
"Multiply"
"Divide"
"Modulus"
"Set"

BrushAxis

(Nullable) Any one of the following String (defaults to None):

NameDescription
"None"
"Auto"
"X"
"Y"
"Z"

Rotation

(Nullable) Any one of the following String (defaults to None):

NameDescription
"None"
"Ninety"
"OneEighty"
"TwoSeventy"

RotationOrigin

(Nullable) Any one of the following String (defaults to OffsetCenter):

NameDescription
"OffsetCenter"
"ClickCenter"
"Player"

BrushShape

(Nullable) Any one of the following String (defaults to Sphere):

NameDescription
"Cube"
"Sphere"
"Cylinder"
"Cone"
"InvertedCone"
"Pyramid"
"InvertedPyramid"
"Dome"
"InvertedDome"
"Diamond"
"Torus"

On this page