ScriptedBrushAsset

← Back to Asset Types

Documentation for the ScriptedBrushAsset asset type.

Location

ScriptedBrushes

Use in Your Files

Add this to your JSON files for IDE autocompletion and validation:

"$schema": "https://hytaledb.ginco.gg/schemas/ScriptedBrushAsset.schema.json" Copy

Schema

Tree

Operations arraynull

The list of brush operations to execute sequentially

Array items: unknown

All of

base

Raw JSON

Copy

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "ScriptedBrushAsset.json",
  "title": "ScriptedBrushAsset",
  "description": "A scripted brush asset containing multiple brush operations that will be executed sequentially",
  "type": "object",
  "allOf": [
    {
      "$ref": "base.schema.json"
    }
  ],
  "properties": {
    "Operations": {
      "type": [
        "array",
        "null"
      ],
      "description": "The list of brush operations to execute sequentially",
      "items": {
        "title": "Type Selector",
        "anyOf": [
          {
            "$ref": "common.schema.json#/$defs/AppendMaskOperation"
          },
          {
            "$ref": "common.schema.json#/$defs/AppendMaskFromToolArgOperation"
          },
          {
            "$ref": "common.schema.json#/$defs/BreakpointOperation"
          },
          {
            "$ref": "common.schema.json#/$defs/ClearOperationMaskOperation"
          },
          {
            "$ref": "common.schema.json#/$defs/DebugBrushOperation"
          },
          {
            "$ref": "common.schema.json#/$defs/DeleteOperation"
          },
          {
            "$ref": "common.schema.json#/$defs/SetDensity"
          },
          {
            "$ref": "common.schema.json#/$defs/DimensionsOperation"
          },
          {
            "$ref": "common.schema.json#/$defs/DisableHoldInteractionOperation"
          },
          {
            "$ref": "common.schema.json#/$defs/EchoOperation"
          },
          {
            "$ref": "common.schema.json#/$defs/EchoOnceOperation"
          },
          {
            "$ref": "common.schema.json#/$defs/ErodeOperation"
          },
          {
            "$ref": "common.schema.json#/$defs/ExitOperation"
          },
          {
            "$ref": "common.schema.json#/$defs/HeightmapLayerOperation"
          },
          {
            "$ref": "common.schema.json#/$defs/HistoryMaskOperation"
          },
          {
            "$ref": "common.schema.json#/$defs/IgnoreExistingBrushDataOperation"
          },
          {
            "$ref": "common.schema.json#/$defs/JumpToIndexOperation"
          },
          {
            "$ref": "common.schema.json#/$defs/JumpIfBlockTypeOperation"
          },
          {
            "$ref": "common.schema.json#/$defs/JumpIfClickType"
          },
          {
            "$ref": "common.schema.json#/$defs/JumpIfCompareOperation"
          },
          {
            "$ref": "common.schema.json#/$defs/JumpIfStringMatchOperation"
          },
          {
            "$ref": "common.schema.json#/$defs/JumpIfToolArgOperation"
          },
          {
            "$ref": "common.schema.json#/$defs/JumpToRandomIndex"
          },
          {
            "$ref": "common.schema.json#/$defs/LayerOperation"
          },
          {
            "$ref": "common.schema.json#/$defs/LiftOperation"
          },
          {
            "$ref": "common.schema.json#/$defs/LoadBrushConfigOperation"
          },
          {
            "$ref": "common.schema.json#/$defs/LoadIntFromToolArgOperation"
          },
          {
            "$ref": "common.schema.json#/$defs/LoadLoopFromToolArgOperation"
          },
          {
            "$ref": "common.schema.json#/$defs/LoadMaterialFromToolArgOperation"
          },
          {
            "$ref": "common.schema.json#/$defs/LoadOperationsFromAssetOperation"
          },
          {
            "$ref": "common.schema.json#/$defs/LoopOperation"
          },
          {
            "$ref": "common.schema.json#/$defs/CircleOffsetAndLoopOperation"
          },
          {
            "$ref": "common.schema.json#/$defs/CircleOffsetFromArgOperation"
          },
          {
            "$ref": "common.schema.json#/$defs/LoopRandomOperation"
          },
          {
            "$ref": "common.schema.json#/$defs/MaskOperation"
          },
          {
            "$ref": "common.schema.json#/$defs/MaterialOperation"
          },
          {
            "$ref": "common.schema.json#/$defs/MeltOperation"
          },
          {
            "$ref": "common.schema.json#/$defs/OffsetOperation"
          },
          {
            "$ref": "common.schema.json#/$defs/PastePrefabOperation"
          },
          {
            "$ref": "common.schema.json#/$defs/BlockPatternOperation"
          },
          {
            "$ref": "common.schema.json#/$defs/PersistentDataOperation"
          },
          {
            "$ref": "common.schema.json#/$defs/RandomizeDimensionsOperation"
          },
          {
            "$ref": "common.schema.json#/$defs/RandomOffsetOperation"
          },
          {
            "$ref": "common.schema.json#/$defs/ReplaceOperation"
          },
          {
            "$ref": "common.schema.json#/$defs/RunCommandOperation"
          },
          {
            "$ref": "common.schema.json#/$defs/SaveBrushConfigOperation"
          },
          {
            "$ref": "common.schema.json#/$defs/SaveIndexOperation"
          },
          {
            "$ref": "common.schema.json#/$defs/SetOperation"
          },
          {
            "$ref": "common.schema.json#/$defs/ShapeOperation"
          },
          {
            "$ref": "common.schema.json#/$defs/SmoothOperation"
          },
          {
            "$ref": "common.schema.json#/$defs/UseBrushMaskOperation"
          },
          {
            "$ref": "common.schema.json#/$defs/UseOperationMaskOperation"
          }
        ]
      }
    }
  }
}