Class PlayerAction<Action>

Action block.

Type Parameters

Action extends DFBlockAction<"player_action">

Block codename.

Hierarchy

ActionBlock<"player_action", Action>
- PlayerAction

Index

Constructors

constructor

new PlayerAction<Action>(action: Action, target?: DFTarget, ...args: DFValueType[]): PlayerAction<Action>
Do a player action.
Type Parameters
- Action extends "SetHotbar" | "SetReducedDebug" | "CloseInv" | "GiveItems" | "NoKeepInv" | "BossBar" | "ParticleSphere" | "SetAtkSpeed" | "SetVelocity" | "Particle" | "AddInvRow" | "DisablePvp" | "NoNatRegen" | "DisplayLightning" | "PlayEntitySound" | "ReplaceProj" | "Damage" | "SetExp" | "SendAnimation" | "SetXPProg" | "SetInventory" | "TpSequence" | "Heal" | "SetSpawnPoint" | "ParticleSpiral" | "SetInventoryKept" | "SetAllowFlight" | "LaunchUp" | "SetMaxHealth" | "RemoveBossBar" | "SetFogDistance" | "GetTargetEntity" | "AdventureMode" | "ForceFlight" | "LoadInv" | "SpectatorMode" | "ClearPotions" | "Kick" | "SetTabListInfo" | "EnablePvp" | "ProjColl" | "HideDisguise" | "SpectateTarget" | "SurvivalMode" | "SetBossBar" | "SetSkin" | "SetStatus" | "SetInvulTicks" | "SetCursorItem" | "SetAbsorption" | "SetFireTicks" | "SetGamemode" | "RemoveInvRow" | "EnableFlight" | "SetStingsStuck" | "DisableBlocks" | "SetScoreObj" | "LSetHealth" | "ParticleEffect" | "ClearInv" | "SetFreezeTicks" | "SetGliding" | "SetRotation" | "RemoveScore" | "DisallowDrops" | "ParticleCircle" | "ClearItems" | "DisplayBlock" | "RideEntity" | "WeatherRain" | "SetFlying" | "RmWorldBorder" | "DisplayBlockOpen" | "SetHandItem" | "SendAdvancement" | "Teleport" | "ClearChat" | "SetAllowPVP" | "SetMenuItem" | "LaunchToward" | "SetArmor" | "DisplayGateway" | "DisableFlight" | "SetVisualFire" | "SetDisguiseVisible" | "SetArrowsStuck" | "GiveExp" | "FaceLocation" | "ClearScoreboard" | "SetItems" | "KeepInv" | "ReplaceItems" | "ActionBar" | "SetChatTag" | "SendMessage" | "ShiftWorldBorder" | "SetSlotItem" | "PlaySoundSeq" | "ParticleLineA" | "DisplaySignText" | "Respawn" | "SetSpeed" | "ExpandInv" | "SetInvName" | "LaunchProj" | "SetItemCooldown" | "SetPlayerWeather" | "SendHover" | "NoProjColl" | "ShowDisguise" | "SetAirTicks" | "DisplayPickup" | "ParticleCuboidA" | "ChatColor" | "SetWorldBorder" | "SetPlayerTime" | "NatRegen" | "GivePotion" | "PlaySound" | "SetCompass" | "RemoveItems" | "BoostElytra" | "RngTeleport" | "SaveInv" | "OpenBook" | "SetHealth" | "MobDisguise" | "BlockDisguise" | "RollbackBlocks" | "NoDeathDrops" | "EnableBlocks" | "WalkSpeed" | "OpenBlockInv" | "SetCollidable" | "LaunchFwd" | "ParticleCircleA" | "SetFallDistance" | "CreativeMode" | "SetEquipment" | "AttackAnimation" | "GiveRngItem" | "SetDropsEnabled" | "RemovePotion" | "DisplayHologram" | "DisplayFracture" | "SetEntityHidden" | "SetSidebar" | "AllowDrops" | "DeathDrops" | "Vibration" | "ShowInv" | "SetSlot" | "ParticleRay" | "SetFoodLevel" | "PlayerDisguise" | "ParticleCuboid" | "SendMessageSeq" | "SetSaturation" | "WeatherClear" | "Undisguise" | "ParticleSpiralA" | "SendTitle" | "InstantRespawn" | "SetScore" | "StopSound" | "SetNameColor" | "ParticleLine"
Parameters
- action: Action
  
  Action to perform.
- Optional target: DFTarget
- Rest ...args: DFValueType[]
  
  Arguments to pass.
Returns PlayerAction<Action>
Overrides ActionBlock.constructor
- Defined in codeblocks/Player.ts:14

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<"player_action", 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: "player_action"

Type of the codeblock.

Methods

export

export(): RawDFActionBlock<"player_action", "SetHotbar" | "SetReducedDebug" | "CloseInv" | "GiveItems" | "NoKeepInv" | "BossBar" | "ParticleSphere" | "SetAtkSpeed" | "SetVelocity" | "Particle" | "AddInvRow" | "DisablePvp" | "NoNatRegen" | "DisplayLightning" | "PlayEntitySound" | "ReplaceProj" | "Damage" | "SetExp" | "SendAnimation" | "SetXPProg" | "SetInventory" | "TpSequence" | "Heal" | "SetSpawnPoint" | "ParticleSpiral" | "SetInventoryKept" | "SetAllowFlight" | "LaunchUp" | "SetMaxHealth" | "RemoveBossBar" | "SetFogDistance" | "GetTargetEntity" | "AdventureMode" | "ForceFlight" | "LoadInv" | "SpectatorMode" | "ClearPotions" | "Kick" | "SetTabListInfo" | "EnablePvp" | "ProjColl" | "HideDisguise" | "SpectateTarget" | "SurvivalMode" | "SetBossBar" | "SetSkin" | "SetStatus" | "SetInvulTicks" | "SetCursorItem" | "SetAbsorption" | "SetFireTicks" | "SetGamemode" | "RemoveInvRow" | "EnableFlight" | "SetStingsStuck" | "DisableBlocks" | "SetScoreObj" | "LSetHealth" | "ParticleEffect" | "ClearInv" | "SetFreezeTicks" | "SetGliding" | "SetRotation" | "RemoveScore" | "DisallowDrops" | "ParticleCircle" | "ClearItems" | "DisplayBlock" | "RideEntity" | "WeatherRain" | "SetFlying" | "RmWorldBorder" | "DisplayBlockOpen" | "SetHandItem" | "SendAdvancement" | "Teleport" | "ClearChat" | "SetAllowPVP" | "SetMenuItem" | "LaunchToward" | "SetArmor" | "DisplayGateway" | "DisableFlight" | "SetVisualFire" | "SetDisguiseVisible" | "SetArrowsStuck" | "GiveExp" | "FaceLocation" | "ClearScoreboard" | "SetItems" | "KeepInv" | "ReplaceItems" | "ActionBar" | "SetChatTag" | "SendMessage" | "ShiftWorldBorder" | "SetSlotItem" | "PlaySoundSeq" | "ParticleLineA" | "DisplaySignText" | "Respawn" | "SetSpeed" | "ExpandInv" | "SetInvName" | "LaunchProj" | "SetItemCooldown" | "SetPlayerWeather" | "SendHover" | "NoProjColl" | "ShowDisguise" | "SetAirTicks" | "DisplayPickup" | "ParticleCuboidA" | "ChatColor" | "SetWorldBorder" | "SetPlayerTime" | "NatRegen" | "GivePotion" | "PlaySound" | "SetCompass" | "RemoveItems" | "BoostElytra" | "RngTeleport" | "SaveInv" | "OpenBook" | "SetHealth" | "MobDisguise" | "BlockDisguise" | "RollbackBlocks" | "NoDeathDrops" | "EnableBlocks" | "WalkSpeed" | "OpenBlockInv" | "SetCollidable" | "LaunchFwd" | "ParticleCircleA" | "SetFallDistance" | "CreativeMode" | "SetEquipment" | "AttackAnimation" | "GiveRngItem" | "SetDropsEnabled" | "RemovePotion" | "DisplayHologram" | "DisplayFracture" | "SetEntityHidden" | "SetSidebar" | "AllowDrops" | "DeathDrops" | "Vibration" | "ShowInv" | "SetSlot" | "ParticleRay" | "SetFoodLevel" | "PlayerDisguise" | "ParticleCuboid" | "SendMessageSeq" | "SetSaturation" | "WeatherClear" | "Undisguise" | "ParticleSpiralA" | "SendTitle" | "InstantRespawn" | "SetScore" | "StopSound" | "SetNameColor" | "ParticleLine">
Serialize the object into a readable DiamondFire format.

Returns
DiamondFire codeblock object.

Returns RawDFActionBlock<"player_action", "SetHotbar" | "SetReducedDebug" | "CloseInv" | "GiveItems" | "NoKeepInv" | "BossBar" | "ParticleSphere" | "SetAtkSpeed" | "SetVelocity" | "Particle" | "AddInvRow" | "DisablePvp" | "NoNatRegen" | "DisplayLightning" | "PlayEntitySound" | "ReplaceProj" | "Damage" | "SetExp" | "SendAnimation" | "SetXPProg" | "SetInventory" | "TpSequence" | "Heal" | "SetSpawnPoint" | "ParticleSpiral" | "SetInventoryKept" | "SetAllowFlight" | "LaunchUp" | "SetMaxHealth" | "RemoveBossBar" | "SetFogDistance" | "GetTargetEntity" | "AdventureMode" | "ForceFlight" | "LoadInv" | "SpectatorMode" | "ClearPotions" | "Kick" | "SetTabListInfo" | "EnablePvp" | "ProjColl" | "HideDisguise" | "SpectateTarget" | "SurvivalMode" | "SetBossBar" | "SetSkin" | "SetStatus" | "SetInvulTicks" | "SetCursorItem" | "SetAbsorption" | "SetFireTicks" | "SetGamemode" | "RemoveInvRow" | "EnableFlight" | "SetStingsStuck" | "DisableBlocks" | "SetScoreObj" | "LSetHealth" | "ParticleEffect" | "ClearInv" | "SetFreezeTicks" | "SetGliding" | "SetRotation" | "RemoveScore" | "DisallowDrops" | "ParticleCircle" | "ClearItems" | "DisplayBlock" | "RideEntity" | "WeatherRain" | "SetFlying" | "RmWorldBorder" | "DisplayBlockOpen" | "SetHandItem" | "SendAdvancement" | "Teleport" | "ClearChat" | "SetAllowPVP" | "SetMenuItem" | "LaunchToward" | "SetArmor" | "DisplayGateway" | "DisableFlight" | "SetVisualFire" | "SetDisguiseVisible" | "SetArrowsStuck" | "GiveExp" | "FaceLocation" | "ClearScoreboard" | "SetItems" | "KeepInv" | "ReplaceItems" | "ActionBar" | "SetChatTag" | "SendMessage" | "ShiftWorldBorder" | "SetSlotItem" | "PlaySoundSeq" | "ParticleLineA" | "DisplaySignText" | "Respawn" | "SetSpeed" | "ExpandInv" | "SetInvName" | "LaunchProj" | "SetItemCooldown" | "SetPlayerWeather" | "SendHover" | "NoProjColl" | "ShowDisguise" | "SetAirTicks" | "DisplayPickup" | "ParticleCuboidA" | "ChatColor" | "SetWorldBorder" | "SetPlayerTime" | "NatRegen" | "GivePotion" | "PlaySound" | "SetCompass" | "RemoveItems" | "BoostElytra" | "RngTeleport" | "SaveInv" | "OpenBook" | "SetHealth" | "MobDisguise" | "BlockDisguise" | "RollbackBlocks" | "NoDeathDrops" | "EnableBlocks" | "WalkSpeed" | "OpenBlockInv" | "SetCollidable" | "LaunchFwd" | "ParticleCircleA" | "SetFallDistance" | "CreativeMode" | "SetEquipment" | "AttackAnimation" | "GiveRngItem" | "SetDropsEnabled" | "RemovePotion" | "DisplayHologram" | "DisplayFracture" | "SetEntityHidden" | "SetSidebar" | "AllowDrops" | "DeathDrops" | "Vibration" | "ShowInv" | "SetSlot" | "ParticleRay" | "SetFoodLevel" | "PlayerDisguise" | "ParticleCuboid" | "SendMessageSeq" | "SetSaturation" | "WeatherClear" | "Undisguise" | "ParticleSpiralA" | "SendTitle" | "InstantRespawn" | "SetScore" | "StopSound" | "SetNameColor" | "ParticleLine">
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): PlayerAction<Action>
Parameters
- action: Action
Returns PlayerAction<Action>
Inherited from ActionBlock.setAction
- Defined in core/components/ActionBlock.ts:81

setArgs

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

setInverted

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

setTarget

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

Action block.

Type Parameters

Action extends DFBlockAction<"player_action">

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

action: Action

Optional target: DFTarget

Rest ...args: DFValueType[]

Returns PlayerAction<Action>

Properties

Readonly _componentName

action

args

isInverted

Readonly tags

Remark

target

Readonly type

Methods

export

Returns

invert

Returns

Returns boolean

setAction

Parameters

action: Action

Returns PlayerAction<Action>

setArgs

Parameters

Rest ...args: DFValueType[]

Returns PlayerAction<Action>

setInverted

Parameters

isInverted: boolean

Returns PlayerAction<Action>

setTarget

Parameters

target: DFTarget

Returns PlayerAction<Action>

toString

Returns string

Settings

Member Visibility

Theme

On This Page

`Optional` target: DFTarget

`Rest` ...args: DFValueType[]

`Readonly` _componentName

`Readonly` tags

`Readonly` type

`Rest` ...args: DFValueType[]