Class VariableCondition<Condition>

Conditional block.

Type Parameters

Condition extends DFBlockAction<"if_var">

Block codename.

Hierarchy

ConditionalBlock<"if_var", Condition>
- VariableCondition

Index

Constructors

constructor

new VariableCondition<Condition>(condition: Condition, ...args: DFValueType[]): VariableCondition<Condition>
If a specific variable has or is equal to a property.
Type Parameters
- Condition extends "IsNear" | "ItemEquals" | "=" | "<=" | "DictValueEquals" | "ItemHasTag" | "StartsWith" | "ListValueEq" | "VarIsType" | "TextMatches" | "VarExists" | "Legacy!=" | "ListContains" | "Legacy=" | "InRange" | "LocIsNear" | "Contains" | "!=" | "<" | ">" | "EndsWith" | ">=" | "DictHasKey"
Parameters
- condition: Condition
  
  Condition to match for.
- Rest ...args: DFValueType[]
  
  Arguments to pass.
Returns VariableCondition<Condition>
Overrides ConditionalBlock.constructor
- Defined in codeblocks/VariableCondition.ts:13

Properties

`Readonly` _componentName

_componentName: string = "serializable"

The component's name

action

action: Condition

The action to check for.

args

args: DFValueType[]

Arguments to pass.

closingBracket

closingBracket: default<"norm", "close"> = ...

Reference property to the closing bracket of this conditional block.

isInverted

isInverted: boolean = false

If the condition is inverted.

openingBracket

openingBracket: default<"norm", "open"> = ...

Reference property to the opening bracket of this conditional block.

`Readonly` tags

tags: BLTagArray<"if_var", Condition> = ...

The tags of the action on this conditional block.

Remark

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

target

target: DFTarget = ...

Target of the action.

`Readonly` type

type: "if_var"

Type of the codeblock.

Methods

export

export(): RawDFConditionalBlock<"if_var">
Serialize the object into a readable DiamondFire format.

Returns
DiamondFire codeblock object.

Returns RawDFConditionalBlock<"if_var">
Inherited from ConditionalBlock.export
- Defined in core/components/ConditionalBlock.ts:123

invert

invert(): boolean
Toggle the 'NOT' inversion.

Returns
True if's inverted, otherwise false.

Returns boolean
Inherited from ConditionalBlock.invert
- Defined in core/components/ConditionalBlock.ts:106

pop

pop(index?: number): VariableCondition<Condition>
Remove from inside blocks.
Parameters
- Optional index: number
  
  Index of the codeblock to remove.
Returns VariableCondition<Condition>
Inherited from ConditionalBlock.pop
- Defined in core/components/ConditionalBlock.ts:97

push

push(...blocks: DFCodeExportableBlock[]): VariableCondition<Condition>
Add to inside blocks.
Parameters
- Rest ...blocks: DFCodeExportableBlock[]
  
  Codeblock(s) to add to the template.
Returns VariableCondition<Condition>
Inherited from ConditionalBlock.push
- Defined in core/components/ConditionalBlock.ts:88

setAction

setAction(action: Condition): VariableCondition<Condition>
Parameters
- action: Condition
Returns VariableCondition<Condition>
Inherited from ConditionalBlock.setAction
- Defined in core/components/ConditionalBlock.ts:137

setArgs

setArgs(...args: DFValueType[]): VariableCondition<Condition>
Parameters
- Rest ...args: DFValueType[]
Returns VariableCondition<Condition>
Inherited from ConditionalBlock.setArgs
- Defined in core/components/ConditionalBlock.ts:142

setInverted

setInverted(isInverted: boolean): VariableCondition<Condition>
Parameters
- isInverted: boolean
Returns VariableCondition<Condition>
Inherited from ConditionalBlock.setInverted
- Defined in core/components/ConditionalBlock.ts:152

setTarget

setTarget(target: DFTarget): VariableCondition<Condition>
Parameters
- target: DFTarget
Returns VariableCondition<Condition>
Inherited from ConditionalBlock.setTarget
- Defined in core/components/ConditionalBlock.ts:147

toString

toString(): string
Stringify the component into JSON pseudo-code.

Returns
String representation

Returns string
Inherited from ConditionalBlock.toString
- Defined in core/components/ConditionalBlock.ts:114

`Static` conditionalBlockHandler

conditionalBlockHandler(raw: RawDFConditionalBlock<"repeat" | "call_func" | "func" | "start_process" | "process" | "player_action" | "if_player" | "control" | "set_var" | "entity_event" | "event" | "if_entity" | "entity_action" | "if_var" | "select_obj" | "game_action" | "else" | "if_game">): readonly [RawDFConditionalBlock<"repeat" | "call_func" | "func" | "start_process" | "process" | "player_action" | "if_player" | "control" | "set_var" | "entity_event" | "event" | "if_entity" | "entity_action" | "if_var" | "select_obj" | "game_action" | "else" | "if_game">, RawDFBracketBlock<DFBracketBlockType, "open">, DFAnySerializedBlock, RawDFBracketBlock<DFBracketBlockType, "close">]
Parameters
- raw: RawDFConditionalBlock<"repeat" | "call_func" | "func" | "start_process" | "process" | "player_action" | "if_player" | "control" | "set_var" | "entity_event" | "event" | "if_entity" | "entity_action" | "if_var" | "select_obj" | "game_action" | "else" | "if_game">
Returns readonly [RawDFConditionalBlock<"repeat" | "call_func" | "func" | "start_process" | "process" | "player_action" | "if_player" | "control" | "set_var" | "entity_event" | "event" | "if_entity" | "entity_action" | "if_var" | "select_obj" | "game_action" | "else" | "if_game">, RawDFBracketBlock<DFBracketBlockType, "open">, DFAnySerializedBlock, RawDFBracketBlock<DFBracketBlockType, "close">]
Inherited from ConditionalBlock.conditionalBlockHandler
- Defined in core/components/ConditionalBlock.ts:37

Class VariableCondition<Condition>

Conditional block.

Type Parameters

Condition extends DFBlockAction<"if_var">

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Condition extends "IsNear" | "ItemEquals" | "=" | "<=" | "DictValueEquals" | "ItemHasTag" | "StartsWith" | "ListValueEq" | "VarIsType" | "TextMatches" | "VarExists" | "Legacy!=" | "ListContains" | "Legacy=" | "InRange" | "LocIsNear" | "Contains" | "!=" | "<" | ">" | "EndsWith" | ">=" | "DictHasKey"

Parameters

condition: Condition

Rest ...args: DFValueType[]

Returns VariableCondition<Condition>

Properties

Readonly _componentName

action

args

closingBracket

isInverted

openingBracket

Readonly tags

Remark

target

Readonly type

Methods

export

Returns

Returns RawDFConditionalBlock<"if_var">

invert

Returns

Returns boolean

pop

Parameters

Optional index: number

Returns VariableCondition<Condition>

push

Parameters

Rest ...blocks: DFCodeExportableBlock[]

Returns VariableCondition<Condition>

setAction

Parameters

action: Condition

Returns VariableCondition<Condition>

setArgs

Parameters

Rest ...args: DFValueType[]

Returns VariableCondition<Condition>

setInverted

Parameters

isInverted: boolean

Returns VariableCondition<Condition>

setTarget

Parameters

target: DFTarget

Returns VariableCondition<Condition>

toString

Returns

Returns string

Static conditionalBlockHandler

Parameters

raw: RawDFConditionalBlock<"repeat" | "call_func" | "func" | "start_process" | "process" | "player_action" | "if_player" | "control" | "set_var" | "entity_event" | "event" | "if_entity" | "entity_action" | "if_var" | "select_obj" | "game_action" | "else" | "if_game">

Settings

Member Visibility

Theme

On This Page

`Rest` ...args: DFValueType[]

`Readonly` _componentName

`Readonly` tags

`Readonly` type

`Optional` index: number

`Rest` ...blocks: DFCodeExportableBlock[]

`Rest` ...args: DFValueType[]

`Static` conditionalBlockHandler