Class SetVariable<Action>

Action block.

Type Parameters

Action extends DFBlockAction<"set_var">

Block codename.

Hierarchy

ActionBlock<"set_var", Action>
- SetVariable

Index

Constructors

constructor

new SetVariable<Action>(action: Action, variable: Variable, ...args: DFValueType[]): SetVariable<Action>
Set a variable using a specific action.
Type Parameters
- Action extends "FaceLocation" | "SetParticleType" | "SetItemEnchants" | "PurgeVars" | "ShiftAllAxes" | "GetParticleMat" | "SetParticleSprd" | "AbsoluteValue" | "AppendValue" | "%" | "ShiftOnVector" | "GetItemAttribute" | "ClearDict" | "+" | "ShiftRotation" | "-" | "GetItemRarity" | "MultiplyVector" | "/" | "GetSignText" | "Bitwise" | "GetLecternPage" | "ParseX" | "ShiftOnAxis" | "ParseY" | "VectorBetween" | "ParseZ" | "GetVectorComp" | "=" | "RmText" | "AddItemAttribute" | "GetCenterLoc" | "AlignLoc" | "GetSoundVolume" | "RandomNumber" | "Raycast" | "RotateAroundVec" | "GetParticleMotion" | "SetParticleMotion" | "RepeatText" | "Average" | "WrapNumber" | "SetY" | "SetMapTexture" | "GetBlockData" | "SetX" | "SortDict" | "GetLecternBook" | "CrossProduct" | "x" | "GetParticleRoll" | "ParseYaw" | "DotProduct" | "SetZ" | "GetPotionType" | "SetItemName" | "ListLength" | "Sine" | "DirectionName" | "GetItemLore" | "ReverseList" | "CreateDict" | "RoundNumber" | "GetItemLoreLine" | "SetVectorLength" | "SetPotionDur" | "NormalRandom" | "SetPotionType" | "AlignVector" | "SetItemDura" | "SetBreakability" | "RaycastEntity" | "SetDictValue" | "SetAllCoords" | "RGBColor" | "SetCanDestroy" | "SplitText" | "HSLColor" | "GetDirection" | "RemoveListIndex" | "Logarithm" | "SetItemTag" | "GetItemAmount" | "SetPotionAmp" | "RotateAroundAxis" | "GetItemName" | "GetItemDura" | "ShiftInDirection" | "ReplaceText" | "TextLength" | "SetLodestoneLoc" | "GetPotionAmp" | "GetParticleAmount" | "GetDictSize" | "SetItemAmount" | "SubtractVectors" | "SetCase" | "SetParticleColor" | "GetLight" | "GetDictValues" | "Vector" | "Distance" | "SetItemLore" | "Root" | "SetParticleAmount" | "AddItemEnchant" | "GetItemType" | "TrimText" | "GetParticleType" | "GetAllBlockData" | "GetDictKeys" | "SetParticleMat" | "GetCoord" | "RemoveItemTag" | "SetParticleSize" | "GetPotionDur" | "RandomLoc" | "SetSoundType" | "GetLodestoneLoc" | "ShiftDirection" | "GetContainerName" | "GetParticleSprd" | "ReflectVector" | "GetHeadOwner" | "GetItemEnchants" | "AppendDict" | "GetMaxItemAmount" | "GetColorChannels" | "SetDirection" | "SetListValue" | "SetBookText" | "RandomValue" | "SetItemType" | "GetSoundType" | "GetListValue" | "Tangent" | "Text" | "VoronoiNoise" | "HSBColor" | "+=" | "GetSoundVariant" | "GetItemColor" | "InsertListValue" | "SetSoundVolume" | "SetCoord" | "AddVectors" | "SetPitch" | "RaycastBlock" | "SetHeadTexture" | "PerlinNoise" | "WorleyNoise" | "SetItemColor" | "GetParticleColor" | "SetSoundPitch" | "SortList" | "RemoveDictEntry" | "FormatTime" | "SetItemFlags" | "GetItemEffects" | "SetYaw" | "SetItemEffects" | "-=" | "GetItemTag" | "CreateList" | "AppendList" | "GetContainerItems" | "ShiftToward" | "TrimList" | "RemoveText" | "Cosine" | "SetVectorComp" | "ParseNumber" | "Exponent" | "ShiftAllDirs" | "GetValueIndex" | "RemItemEnchant" | "GetBookText" | "SetParticleRoll" | "SetSoundVariant" | "ShiftLocation" | "RandomizeList" | "ClampNumber" | "Round" | "GetSoundPitch" | "JoinText" | "TranslateColors" | "GetBlockGrowth" | "GetAllItemTags" | "RemoveListValue" | "ShiftAllDirections" | "SetCanPlaceOn" | "GetBlockType" | "ParsePitch" | "GetDictValue" | "ContainerLock" | "GetBlockPower" | "GetVectorLength" | "SetModelData" | "SetCoords" | "GetParticleSize"
Parameters
- action: Action
  
  Action to perform.
- variable: Variable
  
  Variable to set.
- Rest ...args: DFValueType[]
  
  Arguments to pass.
Returns SetVariable<Action>
Overrides ActionBlock.constructor
- Defined in codeblocks/SetVariable.ts:17
new SetVariable<Action>(action: Action, ...args: DFValueType[]): SetVariable<Action>
Type Parameters
- Action extends "FaceLocation" | "SetParticleType" | "SetItemEnchants" | "PurgeVars" | "ShiftAllAxes" | "GetParticleMat" | "SetParticleSprd" | "AbsoluteValue" | "AppendValue" | "%" | "ShiftOnVector" | "GetItemAttribute" | "ClearDict" | "+" | "ShiftRotation" | "-" | "GetItemRarity" | "MultiplyVector" | "/" | "GetSignText" | "Bitwise" | "GetLecternPage" | "ParseX" | "ShiftOnAxis" | "ParseY" | "VectorBetween" | "ParseZ" | "GetVectorComp" | "=" | "RmText" | "AddItemAttribute" | "GetCenterLoc" | "AlignLoc" | "GetSoundVolume" | "RandomNumber" | "Raycast" | "RotateAroundVec" | "GetParticleMotion" | "SetParticleMotion" | "RepeatText" | "Average" | "WrapNumber" | "SetY" | "SetMapTexture" | "GetBlockData" | "SetX" | "SortDict" | "GetLecternBook" | "CrossProduct" | "x" | "GetParticleRoll" | "ParseYaw" | "DotProduct" | "SetZ" | "GetPotionType" | "SetItemName" | "ListLength" | "Sine" | "DirectionName" | "GetItemLore" | "ReverseList" | "CreateDict" | "RoundNumber" | "GetItemLoreLine" | "SetVectorLength" | "SetPotionDur" | "NormalRandom" | "SetPotionType" | "AlignVector" | "SetItemDura" | "SetBreakability" | "RaycastEntity" | "SetDictValue" | "SetAllCoords" | "RGBColor" | "SetCanDestroy" | "SplitText" | "HSLColor" | "GetDirection" | "RemoveListIndex" | "Logarithm" | "SetItemTag" | "GetItemAmount" | "SetPotionAmp" | "RotateAroundAxis" | "GetItemName" | "GetItemDura" | "ShiftInDirection" | "ReplaceText" | "TextLength" | "SetLodestoneLoc" | "GetPotionAmp" | "GetParticleAmount" | "GetDictSize" | "SetItemAmount" | "SubtractVectors" | "SetCase" | "SetParticleColor" | "GetLight" | "GetDictValues" | "Vector" | "Distance" | "SetItemLore" | "Root" | "SetParticleAmount" | "AddItemEnchant" | "GetItemType" | "TrimText" | "GetParticleType" | "GetAllBlockData" | "GetDictKeys" | "SetParticleMat" | "GetCoord" | "RemoveItemTag" | "SetParticleSize" | "GetPotionDur" | "RandomLoc" | "SetSoundType" | "GetLodestoneLoc" | "ShiftDirection" | "GetContainerName" | "GetParticleSprd" | "ReflectVector" | "GetHeadOwner" | "GetItemEnchants" | "AppendDict" | "GetMaxItemAmount" | "GetColorChannels" | "SetDirection" | "SetListValue" | "SetBookText" | "RandomValue" | "SetItemType" | "GetSoundType" | "GetListValue" | "Tangent" | "Text" | "VoronoiNoise" | "HSBColor" | "+=" | "GetSoundVariant" | "GetItemColor" | "InsertListValue" | "SetSoundVolume" | "SetCoord" | "AddVectors" | "SetPitch" | "RaycastBlock" | "SetHeadTexture" | "PerlinNoise" | "WorleyNoise" | "SetItemColor" | "GetParticleColor" | "SetSoundPitch" | "SortList" | "RemoveDictEntry" | "FormatTime" | "SetItemFlags" | "GetItemEffects" | "SetYaw" | "SetItemEffects" | "-=" | "GetItemTag" | "CreateList" | "AppendList" | "GetContainerItems" | "ShiftToward" | "TrimList" | "RemoveText" | "Cosine" | "SetVectorComp" | "ParseNumber" | "Exponent" | "ShiftAllDirs" | "GetValueIndex" | "RemItemEnchant" | "GetBookText" | "SetParticleRoll" | "SetSoundVariant" | "ShiftLocation" | "RandomizeList" | "ClampNumber" | "Round" | "GetSoundPitch" | "JoinText" | "TranslateColors" | "GetBlockGrowth" | "GetAllItemTags" | "RemoveListValue" | "ShiftAllDirections" | "SetCanPlaceOn" | "GetBlockType" | "ParsePitch" | "GetDictValue" | "ContainerLock" | "GetBlockPower" | "GetVectorLength" | "SetModelData" | "SetCoords" | "GetParticleSize"
Parameters
- action: Action
- Rest ...args: DFValueType[]
Returns SetVariable<Action>
Overrides ActionBlock<"set_var", Action>.constructor
- Defined in codeblocks/SetVariable.ts:18

Properties

`Readonly` _componentName

_componentName: string = "serializable"

The component's name

action

action: Action

The action to perform.

args

args: DFValueType[]

Arguments to pass.

isInverted

isInverted: boolean = false

If the codeblock is inverted (mostly for conditional blocks).

`Readonly` tags

tags: BLTagArray<"set_var", Action> = ...

The tags of the action on this action block.

Remark

Will be an empty array if the action has no tags.

target

target: DFTarget = ...

The target for the action.

`Readonly` type

type: "set_var"

Type of the codeblock.

variable

variable: Variable

Methods

export

export(): RawDFActionBlock<"set_var", "FaceLocation" | "SetParticleType" | "SetItemEnchants" | "PurgeVars" | "ShiftAllAxes" | "GetParticleMat" | "SetParticleSprd" | "AbsoluteValue" | "AppendValue" | "%" | "ShiftOnVector" | "GetItemAttribute" | "ClearDict" | "+" | "ShiftRotation" | "-" | "GetItemRarity" | "MultiplyVector" | "/" | "GetSignText" | "Bitwise" | "GetLecternPage" | "ParseX" | "ShiftOnAxis" | "ParseY" | "VectorBetween" | "ParseZ" | "GetVectorComp" | "=" | "RmText" | "AddItemAttribute" | "GetCenterLoc" | "AlignLoc" | "GetSoundVolume" | "RandomNumber" | "Raycast" | "RotateAroundVec" | "GetParticleMotion" | "SetParticleMotion" | "RepeatText" | "Average" | "WrapNumber" | "SetY" | "SetMapTexture" | "GetBlockData" | "SetX" | "SortDict" | "GetLecternBook" | "CrossProduct" | "x" | "GetParticleRoll" | "ParseYaw" | "DotProduct" | "SetZ" | "GetPotionType" | "SetItemName" | "ListLength" | "Sine" | "DirectionName" | "GetItemLore" | "ReverseList" | "CreateDict" | "RoundNumber" | "GetItemLoreLine" | "SetVectorLength" | "SetPotionDur" | "NormalRandom" | "SetPotionType" | "AlignVector" | "SetItemDura" | "SetBreakability" | "RaycastEntity" | "SetDictValue" | "SetAllCoords" | "RGBColor" | "SetCanDestroy" | "SplitText" | "HSLColor" | "GetDirection" | "RemoveListIndex" | "Logarithm" | "SetItemTag" | "GetItemAmount" | "SetPotionAmp" | "RotateAroundAxis" | "GetItemName" | "GetItemDura" | "ShiftInDirection" | "ReplaceText" | "TextLength" | "SetLodestoneLoc" | "GetPotionAmp" | "GetParticleAmount" | "GetDictSize" | "SetItemAmount" | "SubtractVectors" | "SetCase" | "SetParticleColor" | "GetLight" | "GetDictValues" | "Vector" | "Distance" | "SetItemLore" | "Root" | "SetParticleAmount" | "AddItemEnchant" | "GetItemType" | "TrimText" | "GetParticleType" | "GetAllBlockData" | "GetDictKeys" | "SetParticleMat" | "GetCoord" | "RemoveItemTag" | "SetParticleSize" | "GetPotionDur" | "RandomLoc" | "SetSoundType" | "GetLodestoneLoc" | "ShiftDirection" | "GetContainerName" | "GetParticleSprd" | "ReflectVector" | "GetHeadOwner" | "GetItemEnchants" | "AppendDict" | "GetMaxItemAmount" | "GetColorChannels" | "SetDirection" | "SetListValue" | "SetBookText" | "RandomValue" | "SetItemType" | "GetSoundType" | "GetListValue" | "Tangent" | "Text" | "VoronoiNoise" | "HSBColor" | "+=" | "GetSoundVariant" | "GetItemColor" | "InsertListValue" | "SetSoundVolume" | "SetCoord" | "AddVectors" | "SetPitch" | "RaycastBlock" | "SetHeadTexture" | "PerlinNoise" | "WorleyNoise" | "SetItemColor" | "GetParticleColor" | "SetSoundPitch" | "SortList" | "RemoveDictEntry" | "FormatTime" | "SetItemFlags" | "GetItemEffects" | "SetYaw" | "SetItemEffects" | "-=" | "GetItemTag" | "CreateList" | "AppendList" | "GetContainerItems" | "ShiftToward" | "TrimList" | "RemoveText" | "Cosine" | "SetVectorComp" | "ParseNumber" | "Exponent" | "ShiftAllDirs" | "GetValueIndex" | "RemItemEnchant" | "GetBookText" | "SetParticleRoll" | "SetSoundVariant" | "ShiftLocation" | "RandomizeList" | "ClampNumber" | "Round" | "GetSoundPitch" | "JoinText" | "TranslateColors" | "GetBlockGrowth" | "GetAllItemTags" | "RemoveListValue" | "ShiftAllDirections" | "SetCanPlaceOn" | "GetBlockType" | "ParsePitch" | "GetDictValue" | "ContainerLock" | "GetBlockPower" | "GetVectorLength" | "SetModelData" | "SetCoords" | "GetParticleSize">
Serialize the object into a readable DiamondFire format.

Returns
DiamondFire codeblock object.

Returns RawDFActionBlock<"set_var", "FaceLocation" | "SetParticleType" | "SetItemEnchants" | "PurgeVars" | "ShiftAllAxes" | "GetParticleMat" | "SetParticleSprd" | "AbsoluteValue" | "AppendValue" | "%" | "ShiftOnVector" | "GetItemAttribute" | "ClearDict" | "+" | "ShiftRotation" | "-" | "GetItemRarity" | "MultiplyVector" | "/" | "GetSignText" | "Bitwise" | "GetLecternPage" | "ParseX" | "ShiftOnAxis" | "ParseY" | "VectorBetween" | "ParseZ" | "GetVectorComp" | "=" | "RmText" | "AddItemAttribute" | "GetCenterLoc" | "AlignLoc" | "GetSoundVolume" | "RandomNumber" | "Raycast" | "RotateAroundVec" | "GetParticleMotion" | "SetParticleMotion" | "RepeatText" | "Average" | "WrapNumber" | "SetY" | "SetMapTexture" | "GetBlockData" | "SetX" | "SortDict" | "GetLecternBook" | "CrossProduct" | "x" | "GetParticleRoll" | "ParseYaw" | "DotProduct" | "SetZ" | "GetPotionType" | "SetItemName" | "ListLength" | "Sine" | "DirectionName" | "GetItemLore" | "ReverseList" | "CreateDict" | "RoundNumber" | "GetItemLoreLine" | "SetVectorLength" | "SetPotionDur" | "NormalRandom" | "SetPotionType" | "AlignVector" | "SetItemDura" | "SetBreakability" | "RaycastEntity" | "SetDictValue" | "SetAllCoords" | "RGBColor" | "SetCanDestroy" | "SplitText" | "HSLColor" | "GetDirection" | "RemoveListIndex" | "Logarithm" | "SetItemTag" | "GetItemAmount" | "SetPotionAmp" | "RotateAroundAxis" | "GetItemName" | "GetItemDura" | "ShiftInDirection" | "ReplaceText" | "TextLength" | "SetLodestoneLoc" | "GetPotionAmp" | "GetParticleAmount" | "GetDictSize" | "SetItemAmount" | "SubtractVectors" | "SetCase" | "SetParticleColor" | "GetLight" | "GetDictValues" | "Vector" | "Distance" | "SetItemLore" | "Root" | "SetParticleAmount" | "AddItemEnchant" | "GetItemType" | "TrimText" | "GetParticleType" | "GetAllBlockData" | "GetDictKeys" | "SetParticleMat" | "GetCoord" | "RemoveItemTag" | "SetParticleSize" | "GetPotionDur" | "RandomLoc" | "SetSoundType" | "GetLodestoneLoc" | "ShiftDirection" | "GetContainerName" | "GetParticleSprd" | "ReflectVector" | "GetHeadOwner" | "GetItemEnchants" | "AppendDict" | "GetMaxItemAmount" | "GetColorChannels" | "SetDirection" | "SetListValue" | "SetBookText" | "RandomValue" | "SetItemType" | "GetSoundType" | "GetListValue" | "Tangent" | "Text" | "VoronoiNoise" | "HSBColor" | "+=" | "GetSoundVariant" | "GetItemColor" | "InsertListValue" | "SetSoundVolume" | "SetCoord" | "AddVectors" | "SetPitch" | "RaycastBlock" | "SetHeadTexture" | "PerlinNoise" | "WorleyNoise" | "SetItemColor" | "GetParticleColor" | "SetSoundPitch" | "SortList" | "RemoveDictEntry" | "FormatTime" | "SetItemFlags" | "GetItemEffects" | "SetYaw" | "SetItemEffects" | "-=" | "GetItemTag" | "CreateList" | "AppendList" | "GetContainerItems" | "ShiftToward" | "TrimList" | "RemoveText" | "Cosine" | "SetVectorComp" | "ParseNumber" | "Exponent" | "ShiftAllDirs" | "GetValueIndex" | "RemItemEnchant" | "GetBookText" | "SetParticleRoll" | "SetSoundVariant" | "ShiftLocation" | "RandomizeList" | "ClampNumber" | "Round" | "GetSoundPitch" | "JoinText" | "TranslateColors" | "GetBlockGrowth" | "GetAllItemTags" | "RemoveListValue" | "ShiftAllDirections" | "SetCanPlaceOn" | "GetBlockType" | "ParsePitch" | "GetDictValue" | "ContainerLock" | "GetBlockPower" | "GetVectorLength" | "SetModelData" | "SetCoords" | "GetParticleSize">
Inherited from ActionBlock.export
- Defined in core/components/ActionBlock.ts:62

invert

invert(): boolean
Invert into a 'NOT' action (mostly for conditional blocks).

Returns
True if inverted, otherwise false.

Returns boolean
Inherited from ActionBlock.invert
- Defined in core/components/ActionBlock.ts:77

setAction

setAction(action: Action): SetVariable<Action>
Parameters
- action: Action
Returns SetVariable<Action>
Inherited from ActionBlock.setAction
- Defined in core/components/ActionBlock.ts:81

setArgs

setArgs(...args: DFValueType[]): SetVariable<Action>
Parameters
- Rest ...args: DFValueType[]
Returns SetVariable<Action>
Inherited from ActionBlock.setArgs
- Defined in core/components/ActionBlock.ts:86

setInverted

setInverted(isInverted: boolean): SetVariable<Action>
Parameters
- isInverted: boolean
Returns SetVariable<Action>
Inherited from ActionBlock.setInverted
- Defined in core/components/ActionBlock.ts:96

setTarget

setTarget(target: DFTarget): SetVariable<Action>
Parameters
- target: DFTarget
Returns SetVariable<Action>
Inherited from ActionBlock.setTarget
- Defined in core/components/ActionBlock.ts:91

toString

toString(): string
Returns string
Inherited from ActionBlock.toString
- Defined in core/components/ActionBlock.ts:52

Class SetVariable<Action>

Action block.

Type Parameters

Action extends DFBlockAction<"set_var">

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

action: Action

variable: Variable

Rest ...args: DFValueType[]

Returns SetVariable<Action>

Type Parameters

Parameters

action: Action

Rest ...args: DFValueType[]

Returns SetVariable<Action>

Properties

Readonly _componentName

action

args

isInverted

Readonly tags

Remark

target

Readonly type

variable

Methods

export

Returns

invert

Returns

Returns boolean

setAction

Parameters

action: Action

Returns SetVariable<Action>

setArgs

Parameters

Rest ...args: DFValueType[]

Returns SetVariable<Action>

setInverted

Parameters

isInverted: boolean

Returns SetVariable<Action>

setTarget

Parameters

target: DFTarget

Returns SetVariable<Action>

toString

Returns string

Settings

Member Visibility

Theme

On This Page

`Rest` ...args: DFValueType[]

`Rest` ...args: DFValueType[]

`Readonly` _componentName

`Readonly` tags

`Readonly` type

`Rest` ...args: DFValueType[]