DF Manual Patch 6.6.1

SET VARIABLE

Used to set the value of a variable.

examples

Set a variable to a sum of numbers
Remove all instances of a certain
string from a string variable
Set a variable to a random value

Actions

Set to String | String (aka. Text)

Tags

name: Text Value Merging default: No spaces options: Add spaces, No spaces
Set Particle Effect Type | SetParticleType (aka. )

| SetItemEnchants (aka. )

Clear Item Custom Tags | ClearItemTag (aka. )

Purge Matching Variables | PurgeVars (aka. )

Tags

name: Match Requirement default: Full word(s) in name options: Entire name, Full word(s) in name, Any part of name

name: Ignore Case default: False options: True, False
Shift Location on All Axes | ShiftAllAxes (aka. ShiftLocCoord)

Get Particle Effect Material | GetParticleMat (aka. )

Set Particle Effect Spread | SetParticleSprd (aka. )

Set to Absolute Value | AbsoluteValue (aka. )

Append Value to List | AppendValue (aka. )

Set to Remainder (%) | % (aka. )

Tags

name: Remainder Mode default: Remainder options: Remainder, Modulo
Shift Location on Vector | ShiftOnVector (aka. AddVectorLoc)

Tags

name: Add Location Rotation default: False options: True, False
Get Item Attribute | GetItemAttribute (aka. )

Tags

name: Attribute default: Armor options: Armor, Armor toughness, Attack damage, Attack speed, Attack knockback, Maximum health, Maximum absorption, Knockback resistance, Movement speed, Flying speed, Follow range, Luck, Horse jump strength, Zombie spawn reinforcements

name: Active Equipment Slot default: Any options: Any, Main hand, Off hand, Head, Body, Legs, Feet
Clear Dictionary | ClearDict (aka. )

Add Numbers (+) | + (aka. )

Shift Location Rotation | ShiftRotation (aka. RotateLocation)

Tags

name: Rotation Axis default: Pitch options: Pitch, Yaw
Subtract Numbers (-) | - (aka. )

Get Item Name | GetItemName (aka. )

Get Item Rarity | GetItemRarity (aka. )

Multiply Vector | MultiplyVector (aka. )

Divide Numbers (÷) | / (aka. )

Tags

name: Division Mode default: Default options: Default, Floor result
| GetSignText (aka. )

Tags

name: Sign Line default: 1 options: 1, 2, 3, 4, All lines
Set to Bitwise Operation | Bitwise (aka. )

Tags

name: Operator default: | options: |, &, ~, ^, <<, >>, >>>
Get Lectern Page | GetLecternPage (aka. )

| ParseX (aka. )

Shift Location on Axis | ShiftOnAxis (aka. ShiftAxis)

Tags

name: Coordinate default: X options: X, Y, Z
| ParseY (aka. )

Set to Vector Between Locations | VectorBetween (aka. )

| ParseZ (aka. )

Get Vector Component | GetVectorComp (aka. )

Tags

name: Component default: X options: X, Y, Z
Set to Value (=) | = (aka. )

| RmText (aka. )

Tags

name: Regular Expressions default: Disable options: Enable, Disable
Add Item Attribute | AddItemAttribute (aka. )

Tags

name: Attribute default: Armor options: Armor, Armor toughness, Attack damage, Attack speed, Attack knockback, Maximum health, Maximum absorption, Knockback resistance, Movement speed, Flying speed, Follow range, Luck, Horse jump strength, Zombie spawn reinforcements

name: Operation default: Add number options: Add number, Add percentage to base, Multiply modifier by percentage

name: Active Equipment Slot default: Main hand options: Any, Main hand, Off hand, Head, Body, Legs, Feet
Set to Center Location | GetCenterLoc (aka. FindCenter)

Align Location | AlignLoc (aka. )

Tags

name: Alignment Mode default: Block center options: Block center, Lower block corner

name: Coordinates default: All coordinates options: All coordinates, X and Z, Only Y

name: Rotation default: Keep rotation options: Keep rotation, Remove rotation
Get Sound Volume | GetSoundVolume (aka. )

Set to Random Number | RandomNumber (aka. )

Tags

name: Rounding Mode default: Whole number options: Whole number, Decimal number
Get Container Name | ContainerName (aka. )

Raycast from Location | Raycast (aka. )

Tags

name: Entity Collision default: False options: True, False

name: Block Collision default: All blocks options: All blocks, Non-fluid blocks, Solid blocks, None
Rotate Vector Around Vector | RotateAroundVec (aka. )

Tags

name: Angle Units default: Degrees options: Degrees, Radians
Get Particle Effect Motion | GetParticleMotion (aka. )

Set Particle Motion | SetParticleMotion (aka. )

Set to Average Number | Average (aka. )

| WrapNumber (aka. )

| SetY (aka. )

Set Map Texture | SetMapTexture (aka. )

Get Block Data | GetBlockData (aka. )

| SetX (aka. )

Sort Dictionary | SortDict (aka. )

Tags

name: Sorting Type default: Sort by Key options: Sort by Key, Sort by Value

name: Sorting Order default: Ascending options: Ascending, Descending
Get Lectern Book | GetLecternBook (aka. )

Get Custom Sound Key | GetCustomSound (aka. )

Set to Cross Product | CrossProduct (aka. )

Multiply Numbers (×) | x (aka. )

Get Particle Roll | GetParticleRoll (aka. )

| ParseYaw (aka. )

Set to Dot Product | DotProduct (aka. )

| SetZ (aka. )

Set Armor Trim | SetArmorTrim (aka. )

Tags

name: Trim Pattern default: None options: None, Coast, Dune, Eye, Rib, Sentry, Snout, Spire, Tide, Vex, Ward, Wayfinder, Shaper, Silence, Raiser, Host, Wild

name: Trim Material default: Amethyst options: Amethyst, Copper, Diamond, Emerald, Gold, Iron, Lapis Lazuli, Netherite, Quartz, Redstone
Pop List Value | PopListValue (aka. )

Get Noise | Noise (aka. )

Tags

name: Return Type default: Simplex options: Simplex, Perlin, Voronoi, Worley, Value

name: Dimensions default: 3D options: 3D, 2D
Set to Minimum Number | MinNumber (aka. MinValue,Min)

Get Potion Effect Type | GetPotionType (aka. )

| SetItemName (aka. )

Get List Length | ListLength (aka. )

Set to Sine | Sine (aka. )

Tags

name: Sine Variant default: Sine options: Sine, Inverse sine (arcsine), Hyperbolic sine

name: Input default: Degrees options: Degrees, Radians
Set to Direction Name | DirectionName (aka. )

Repeat String | RepeatString (aka. DuplicateText,RepeatText)

| GetItemLore (aka. )

Join String | JoinString (aka. JoinText)

Reverse List | ReverseList (aka. )

Remove Duplicate List Elements | DedupList (aka. )

Create Dictionary | CreateDict (aka. )

| RoundNumber (aka. )

Tags

name: Round Mode default: Nearest options: Floor, Nearest, Ceiling
Face Location | FaceLocation (aka. )

Tags

name: Face Direction default: Toward location options: Toward location, Away from location
| GetItemLoreLine (aka. )

Set Vector Length | SetVectorLength (aka. )

Set Potion Effect Duration | SetPotionDur (aka. )

Get Block Blast Resistance | BlockResistance (aka. )

Split String | SplitString (aka. SplitText)

Set to Normally Distributed Random Number | NormalRandom (aka. )

Tags

name: Distribution default: Normal options: Normal, Folded normal
Set Potion Effect Type | SetPotionType (aka. )

Align Vector | AlignVector (aka. )

Set Item Durability | SetItemDura (aka. )

Tags

name: Durability Type default: Set Damage options: Set Damage, Set Damage Percentage, Set Remaining, Set Remaining Percentage
Set Item Breakability | SetBreakability (aka. )

Tags

name: Breakability default: Unbreakable options: Breakable, Unbreakable
Get Sign Text | GetSignText (aka. )

Tags

name: Sign Line default: 1 options: 1, 2, 3, 4, All lines

name: Sign Side default: Front options: Front, Back
| RaycastEntity (aka. )

Set Dictionary Value | SetDictValue (aka. )

Set All Location Coordinates | SetAllCoords (aka. )

Tags

name: Coordinate Type default: Plot coordinate options: Plot coordinate, World coordinate
Set to RGB Color | RGBColor (aka. )

Set Breakable Blocks | SetCanDestroy (aka. )

Set to HSL Color | HSLColor (aka. )

| GetDirection (aka. )

Tags

name: Return Type default: Text (3D) options: Text (3D), Text (2D), Vector
Get Item Lore | GetItemLore (aka. )

Remove List Value at Index | RemoveListIndex (aka. )

Get Cellular Noise | CellularNoise (aka. )

Tags

name: Return Type default: Voronoi options: Voronoi, Worley, Secondary, Additive, Subtractive, Divisive, Multiplicative, Origin

name: Distance Calculation default: Euclidean options: Euclidean, Manhattan, Natural

name: Domain Fractal default: Progressive options: Progressive, Independent

name: Dimensions default: 3D options: 3D, 2D
Set to Logarithm | Logarithm (aka. )

Set Item Custom Tag | SetItemTag (aka. )

Trim String | TrimString (aka. TrimText)

Parse MiniMessage Expression | ParseMiniMessageExpr (aka. )

Tags

name: Allowed Tags default: Style Only options: Style Only, Dynamic, Full

name: Parse Legacy Color Codes default: False options: True, False
Get Item Stack Size | GetItemAmount (aka. )

Set Potion Effect Amplifier | SetPotionAmp (aka. )

Get Breakable Blocks | GetCanDestroy (aka. )

Rotate Vector Around Axis | RotateAroundAxis (aka. )

Tags

name: Axis default: X options: X, Y, Z

name: Angle Units default: Degrees options: Degrees, Radians
| GetItemName (aka. )

Get Item Durability | GetItemDura (aka. )

Tags

name: Durability Type default: Get Damage options: Get Damage, Get Damage Percentage, Get Remaining, Get Remaining Percentage, Get Maximum
Shift Location in Direction | ShiftInDirection (aka. )

Tags

name: Direction default: Forward options: Forward, Upward, Sideways
Wrap Number | WrapNum (aka. )

Replace String | ReplaceString (aka. ReplaceText)

Tags

name: Regular Expressions default: Disable options: Enable, Disable

name: Replacement Type default: All occurrences options: First occurrence, All occurrences
Set Item Name | SetItemName (aka. )

Set Compass Lodestone Location | SetLodestoneLoc (aka. )

Tags

name: Require Lodestone at Location default: False options: True, False
Flatten List | FlattenList (aka. )

Get Block Hardness | BlockHardness (aka. )

Get Potion Effect Amplifier | GetPotionAmp (aka. )

Get Particle Effect Amount | GetParticleAmount (aka. )

Get Dictionary Size | GetDictSize (aka. )

Set Item Stack Size | SetItemAmount (aka. )

Subtract Vectors | SubtractVectors (aka. )

Set String Case | SetCase (aka. )

Tags

name: Capitalization Type default: UPPERCASE options: UPPERCASE, lowercase, Proper Case, iNVERT CASE, RAnDoM cASe
Set Particle Effect Color | SetParticleColor (aka. )

Get Light Level | GetLight (aka. )

Tags

name: Light Type default: Combined light options: Combined light, Sky light, Block light
Get Book Text | GetBookText (aka. )

Get Dictionary Values | GetDictValues (aka. )

Set to Vector | Vector (aka. )

Set to Distance | Distance (aka. )

Tags

name: Distance Type default: Distance 3D (X/Y/Z) options: Distance 2D (X/Z), Distance 3D (X/Y/Z), Altitude (Y)
| SetItemLore (aka. )

Set to Root | Root (aka. SquareRoot)

Set Particle Effect Amount | SetParticleAmount (aka. )

Add Item Enchantment | AddItemEnchant (aka. )

Get Item Material | GetItemType (aka. )

Tags

name: Return Value Type default: Item ID (golden_apple) options: Item ID (golden_apple), Item Name (Golden Apple), Item
Get Location Direction | GetDirection (aka. )

Get Item Lore Line | GetLoreLine (aka. )

Get Particle Effect Type | GetParticleType (aka. )

Remove String | RemoveString (aka. RemoveText)

Tags

name: Regular Expressions default: Disable options: Enable, Disable
Get All Block Data | GetAllBlockData (aka. )

Tags

name: Hide Default default: True options: True, False
Set to Maximum Number | MaxNumber (aka. MaxValue,Max)

Get Dictionary Keys | GetDictKeys (aka. )

Trim Styled Text Content | TrimStyledText (aka. )

Set Particle Effect Material | SetParticleMat (aka. )

Get Location Coordinate | GetCoord (aka. )

Tags

name: Coordinate Type default: Plot coordinate options: Plot coordinate, World coordinate

name: Coordinate default: X options: X, Y, Z, Pitch, Yaw
Remove Item Custom Tag | RemoveItemTag (aka. )

Set Particle Effect Size | SetParticleSize (aka. )

Get Potion Effect Duration | GetPotionDur (aka. )

Set to Random Location | RandomLoc (aka. )

Set Sound Type | SetSoundType (aka. )

Get Compass Lodestone Location | GetLodestoneLoc (aka. )

| ShiftDirection (aka. )

Tags

name: Direction default: Forwards 3D (X/Y/Z) options: Forwards 2D (X/Z), Forwards 3D (X/Y/Z), Sideways (-L / +R)
| GetContainerName (aka. )

Get Particle Effect Spread | GetParticleSprd (aka. )

Tags

name: Spread default: Horizontal options: Horizontal, Vertical
Reflect Vector | ReflectVector (aka. )

Get Head Owner | GetHeadOwner (aka. )

Tags

name: Text Value default: Owner Name options: Owner Name, Owner UUID
| GetItemEnchants (aka. )

Append Dictionary | AppendDict (aka. )

Get Item Maximum Stack Size | GetMaxItemAmount (aka. )

Get Color Channels | GetColorChannels (aka. )

Tags

name: Color Channels default: RGB options: RGB, HSB, HSL
Set Location Direction | SetDirection (aka. )

Set List Value | SetListValue (aka. )

Set Item Enchantments | SetItemEnchants (aka. )

Set Book Text | SetBookText (aka. )

Set to Random Value | RandomValue (aka. RandomObj)

Set Item Material | SetItemType (aka. )

Get Sound Type | GetSoundType (aka. )

Get List Value | GetListValue (aka. )

Bounce Number | BounceNum (aka. )

Set to Tangent | Tangent (aka. )

Tags

name: Tangent Variant default: Tangent options: Tangent, Inverse tangent (arctangent), Hyperbolic tangent

name: Input default: Degrees options: Degrees, Radians
Get Voronoi Noise | VoronoiNoise (aka. )

Tags

name: Cell Edge Type default: Euclidean options: Euclidean, Manhattan, Natural
| SetDirection (aka. FaceDirection)

Tags

name: Face Direction default: Towards direction options: Towards direction, Towards opposite direction
Set to HSB Color | HSBColor (aka. HSVColor)

Increment Number (+=) | += (aka. )

Get Sound Variant | GetSoundVariant (aka. )

Get Item Color | GetItemColor (aka. )

Clear Formatting | ClearFormatting (aka. )

Insert List Value | InsertListValue (aka. InsertListIndex)

Set Sound Volume | SetSoundVolume (aka. )

Set Location Coordinate | SetCoord (aka. )

Tags

name: Coordinate Type default: Plot coordinate options: Plot coordinate, World coordinate

name: Coordinate default: X options: X, Y, Z, Pitch, Yaw
Add Vectors | AddVectors (aka. )

| SetPitch (aka. )

| RaycastBlock (aka. )

Tags

name: Ignore Passable Blocks default: False options: True, False

name: Fluid Collision default: Ignore fluids options: Ignore fluids, Detect fluids, Source blocks only
Get Item Enchantments | GetItemEnchants (aka. )

Set Head Texture | SetHeadTexture (aka. SetHeadOwner)

Get Perlin Noise | PerlinNoise (aka. )

Tags

name: Fractal Type default: Brownian options: Brownian, Billow (Dark edges), Rigid (Light edges)
Get Worley Noise | WorleyNoise (aka. )

Tags

name: Cell Edge Type default: Euclidean options: Euclidean, Manhattan, Natural

name: Distance Calculation default: Primary options: Primary, Secondary, Additive, Subtractive, Multiplicative, Divisive
Set Item Color | SetItemColor (aka. SetLeatherColor)

Get Particle Effect Color | GetParticleColor (aka. )

Set Sound Pitch | SetSoundPitch (aka. )

Round Number | RoundNumber (aka. )

Tags

name: Round Mode default: Nearest options: Floor, Nearest, Ceiling
Get Placeable Blocks | GetCanPlaceOn (aka. )

Sort List | SortList (aka. )

Tags

name: Sort Order default: Ascending options: Ascending, Descending
Set Custom Sound Key | SetCustomSound (aka. )

Remove Dictionary Entry | RemoveDictEntry (aka. )

Format Timestamp | FormatTime (aka. )

Tags

name: Format default: 2020/08/17 17:20:54 options: Custom, 2020/08/17 17:20:54, 2020/08/17, Mon, August 17, Monday, 17:20:54, 5:20 PM, 17h20m54s, 54.229 seconds
Set Item Visibility Flags | SetItemFlags (aka. )

Tags

name: Hide Armor Trim default: No Change options: True, False, No Change

name: Hide Color default: No Change options: True, False, No Change

name: Hide Enchantments default: No Change options: True, False, No Change

name: Hide Attributes default: No Change options: True, False, No Change

name: Hide Unbreakable default: No Change options: True, False, No Change

name: Hide Can Destroy default: No Change options: True, False, No Change

name: Hide Can Place On default: No Change options: True, False, No Change

name: Hide Potion Effects default: No Change options: True, False, No Change
Get String Length | StringLength (aka. TextLength)

Get Item Potion Effects | GetItemEffects (aka. )

Set to Styled Text | StyledText (aka. )

Tags

name: Text Value Merging default: No spaces options: Add spaces, No spaces

name: Inherit Styles default: True options: True, False
Get MiniMessage Expression | GetMiniMessageExpr (aka. )

| SetYaw (aka. )

Set Item Lore | SetItemLore (aka. )

Set Item Potion Effects | SetItemEffects (aka. )

Decrement Number (-=) | -= (aka. )

Get Item Custom Tag | GetItemTag (aka. )

Create List | CreateList (aka. )

Append List to List | AppendList (aka. )

Get Container Contents | GetContainerItems (aka. )

Tags

name: Ignore Empty Slots default: False options: True, False
Shift Location Toward Location | ShiftToward (aka. ShiftTowards,ShiftLocTowards)

Trim List | TrimList (aka. )

Get Gradient Noise | GradientNoise (aka. )

Tags

name: Dimensions default: 3D options: 3D, 2D

name: Domain Fractal default: Progressive options: Progressive, Independent

name: Return Type default: Simplex options: Simplex, Perlin
Clear Item Enchantments | ClearEnchants (aka. )

Set to Cosine | Cosine (aka. )

Tags

name: Cosine Variant default: Cosine options: Cosine, Inverse cosine (arccosine), Hyperbolic cosine

name: Input default: Degrees options: Degrees, Radians
Set Vector Component | SetVectorComp (aka. )

Tags

name: Component default: X options: X, Y, Z
Parse Number from String | ParseNumber (aka. )

Set to Exponential | Exponent (aka. )

| ShiftAllDirs (aka. )

Tags

name: Ignore Pitch default: False options: True, False
Get List Index of Value | GetValueIndex (aka. )

Tags

name: Search Order default: Ascending (first index) options: Ascending (first index), Descending (last index)
Remove Item Enchantment | RemItemEnchant (aka. )

| GetBookText (aka. )

Set Particle Roll | SetParticleRoll (aka. )

Set Sound Variant | SetSoundVariant (aka. )

| ShiftLocation (aka. )

Tags

name: Shift Direction default: (+) Forwards / (-) Backwards options: (+) Upwards / (-) Downwards, (+) Forwards / (-) Backwards, (+) Right / (-) Left
Randomize List | RandomizeList (aka. )

Clamp Number | ClampNumber (aka. )

| Round (aka. )

Tags

name: Round Mode default: Nearest options: Floor, Nearest, Ceiling
Get Sound Pitch | GetSoundPitch (aka. )

Tags

name: Return Value Type default: Pitch (number) options: Pitch (number), Note (text)
Translate Legacy Colors | TranslateColors (aka. )

Tags

name: Translation Type default: From & to color options: From hex to color, From & to color, From color to &, Strip color
Get Block Growth | GetBlockGrowth (aka. )

Tags

name: Growth Unit default: Growth stage number options: Growth stage number, Growth percentage
Get All Custom Item Tags | GetAllItemTags (aka. )

Remove List Value | RemoveListValue (aka. )

Shift Location in All Directions | ShiftAllDirections (aka. )

Get Value Noise | ValueNoise (aka. )

Tags

name: Dimensions default: 3D options: 3D, 2D

name: Domain Fractal default: Progressive options: Progressive, Independent

name: Return Type default: Value options: Value, Cubic
Set Placeable Blocks | SetCanPlaceOn (aka. )

Get Block Material | GetBlockType (aka. )

Tags

name: Return Value Type default: Block ID (oak_log) options: Block ID (oak_log), Block name (Oak Log), Item
| ParsePitch (aka. )

Get Dictionary Value | GetDictValue (aka. )

Get Container Lock | ContainerLock (aka. )

Get Block Power | GetBlockPower (aka. )

Get Vector Length | GetVectorLength (aka. )

Tags

name: Length Type default: Length options: Length, Length Squared
Get Text Content Length | ContentLength (aka. )

Set Custom Model Data | SetModelData (aka. )

| SetCoords (aka. )

Get Particle Effect Size | GetParticleSize (aka. )