Class PlayerCondition<Condition>

Conditional block.

Type Parameters

Condition extends DFBlockAction<"if_player">

Block codename.

Hierarchy

ConditionalBlock<"if_player", Condition>
- PlayerCondition

Index

Constructors

constructor

new PlayerCondition<Condition>(condition: Condition, target?: DFTarget, ...args: DFValueType[]): PlayerCondition<Condition>
If a player did something.
Type Parameters
- Condition extends "IsLookingAt" | "InWorldBorder" | "HasRoomForItem" | "IsHoldingOff" | "NoItemCooldown" | "IsUsingItem" | "HasAllItems" | "IsSwimming" | "HasItem" | "BlockEquals" | "IsWearing" | "IsNear" | "IsRiding" | "StandingOn" | "CmdEquals" | "IsGrounded" | "CursorItem" | "SlotEquals" | "ItemEquals" | "IsHoldingMain" | "IsHolding" | "MenuSlotEquals" | "IsBlocking" | "HasPermission" | "IsSneaking" | "IsFlying" | "HasPotion" | "NameEquals" | "InvOpen" | "HasSlotItem" | "IsSprinting" | "IsGliding" | "CmdArgEquals"
Parameters
- condition: Condition
  
  Action of condition.
- Optional target: DFTarget
  
  Target of the condition.
- Rest ...args: DFValueType[]
  
  Arguments to pass.
Returns PlayerCondition<Condition>
Overrides ConditionalBlock.constructor
- Defined in codeblocks/Player.ts:42

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_player", 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_player"

Type of the codeblock.

Methods

export

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

Returns
DiamondFire codeblock object.

Returns RawDFConditionalBlock<"if_player">
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): PlayerCondition<Condition>
Remove from inside blocks.
Parameters
- Optional index: number
  
  Index of the codeblock to remove.
Returns PlayerCondition<Condition>
Inherited from ConditionalBlock.pop
- Defined in core/components/ConditionalBlock.ts:97

push

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

setAction

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

setArgs

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

setInverted

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

setTarget

setTarget(target: DFTarget): PlayerCondition<Condition>
Parameters
- target: DFTarget
Returns PlayerCondition<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 PlayerCondition<Condition>

Conditional block.

Type Parameters

Condition extends DFBlockAction<"if_player">

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

condition: Condition

Optional target: DFTarget

Rest ...args: DFValueType[]

Returns PlayerCondition<Condition>

Properties

Readonly _componentName

action

args

closingBracket

isInverted

openingBracket

Readonly tags

Remark

target

Readonly type

Methods

export

Returns

Returns RawDFConditionalBlock<"if_player">

invert

Returns

Returns boolean

pop

Parameters

Optional index: number

Returns PlayerCondition<Condition>

push

Parameters

Rest ...blocks: DFCodeExportableBlock[]

Returns PlayerCondition<Condition>

setAction

Parameters

action: Condition

Returns PlayerCondition<Condition>

setArgs

Parameters

Rest ...args: DFValueType[]

Returns PlayerCondition<Condition>

setInverted

Parameters

isInverted: boolean

Returns PlayerCondition<Condition>

setTarget

Parameters

target: DFTarget

Returns PlayerCondition<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

`Optional` target: DFTarget

`Rest` ...args: DFValueType[]

`Readonly` _componentName

`Readonly` tags

`Readonly` type

`Optional` index: number

`Rest` ...blocks: DFCodeExportableBlock[]

`Rest` ...args: DFValueType[]

`Static` conditionalBlockHandler