Class ConditionalBlock<T, Action, Target>`Abstract`

Conditional block.

Type Parameters

T extends DFBlockCodename

Block codename.
Action extends DFBlockAction<T>
Target extends DFTarget = DFTarget

Selection to target.

Hierarchy

SerializableComponent<RawDFConditionalBlock<T>>
- ConditionalBlock

Index

Constructors

constructor

new ConditionalBlock<T, Action, Target>(type: T, action: Action, args: DFValueType[], isInverted?: boolean, target?: Target): ConditionalBlock<T, Action, Target>
Create a new conditional codeblock.
Type Parameters
- T extends "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"
- Action extends string
- Target extends DFTarget = DFTarget
Parameters
- type: T
  
  Type of the codeblock.
- action: Action
  
  The action to check for.
- args: DFValueType[]
  
  Arguments to pass.
- isInverted: boolean = false
  
  If the condition is inverted.
- target: Target = ...
  
  Target of the action.
Returns ConditionalBlock<T, Action, Target>
Overrides SerializableComponent.constructor
- Defined in core/components/ConditionalBlock.ts:74

Properties

`Readonly` _componentName

_componentName: string = "serializable"

The component's name

`Private` _internalTemplate

_internalTemplate: Template = ...

Inside template.

action

action: Action

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<T, Action> = ...

The tags of the action on this conditional block.

Remark

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

target

target: Target = ...

Target of the action.

`Readonly` type

type: T

Type of the codeblock.

Methods

export

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

Returns
DiamondFire codeblock object.

Returns RawDFConditionalBlock<T>
Overrides SerializableComponent.export
- Defined in core/components/ConditionalBlock.ts:123

invert

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

Returns
True if's inverted, otherwise false.

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

pop

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

push

push(...blocks: DFCodeExportableBlock[]): ConditionalBlock<T, Action, Target>
Add to inside blocks.
Parameters
- Rest ...blocks: DFCodeExportableBlock[]
  
  Codeblock(s) to add to the template.
Returns ConditionalBlock<T, Action, Target>
- Defined in core/components/ConditionalBlock.ts:88

setAction

setAction(action: Action): ConditionalBlock<T, Action, Target>
Parameters
- action: Action
Returns ConditionalBlock<T, Action, Target>
- Defined in core/components/ConditionalBlock.ts:137

setArgs

setArgs(...args: DFValueType[]): ConditionalBlock<T, Action, Target>
Parameters
- Rest ...args: DFValueType[]
Returns ConditionalBlock<T, Action, Target>
- Defined in core/components/ConditionalBlock.ts:142

setInverted

setInverted(isInverted: boolean): ConditionalBlock<T, Action, Target>
Parameters
- isInverted: boolean
Returns ConditionalBlock<T, Action, Target>
- Defined in core/components/ConditionalBlock.ts:152

setTarget

setTarget(target: Target): ConditionalBlock<T, Action, Target>
Parameters
- target: Target
Returns ConditionalBlock<T, Action, Target>
- Defined in core/components/ConditionalBlock.ts:147

toString

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

Returns
String representation

Returns string
Overrides SerializableComponent.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">]
- Defined in core/components/ConditionalBlock.ts:37

Class ConditionalBlock<T, Action, Target>Abstract

Conditional block.

Type Parameters

T extends DFBlockCodename

Action extends DFBlockAction<T>

Target extends DFTarget = DFTarget

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

T extends "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"

Action extends string

Target extends DFTarget = DFTarget

Parameters

type: T

action: Action

args: DFValueType[]

isInverted: boolean = false

target: Target = ...

Returns ConditionalBlock<T, Action, Target>

Properties

Readonly _componentName

Private _internalTemplate

action

args

closingBracket

isInverted

openingBracket

Readonly tags

Remark

target

Readonly type

Methods

export

Returns

Returns RawDFConditionalBlock<T>

invert

Returns

Returns boolean

pop

Parameters

Optional index: number

Returns ConditionalBlock<T, Action, Target>

push

Parameters

Rest ...blocks: DFCodeExportableBlock[]

Returns ConditionalBlock<T, Action, Target>

setAction

Parameters

action: Action

Returns ConditionalBlock<T, Action, Target>

setArgs

Parameters

Rest ...args: DFValueType[]

Returns ConditionalBlock<T, Action, Target>

setInverted

Parameters

isInverted: boolean

Returns ConditionalBlock<T, Action, Target>

setTarget

Parameters

target: Target

Returns ConditionalBlock<T, Action, Target>

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

Class ConditionalBlock<T, Action, Target>`Abstract`

`Readonly` _componentName

`Private` _internalTemplate

`Readonly` tags

`Readonly` type

`Optional` index: number

`Rest` ...blocks: DFCodeExportableBlock[]

`Rest` ...args: DFValueType[]

`Static` conditionalBlockHandler