Class BlockAction

constructor

• new BlockAction(type): BlockAction

• Initializes a new BlockAction.

  Parameters

  • type: string

  Returns BlockAction

  Memberof

  BlockAction

parameters

type

clone

• clone(): BlockAction

• Clones the block action into a new instance.

  Returns BlockAction

  A new instance of the current block action.

  Memberof

  BlockAction

serialize

• serialize(): any

• Serializes the block action into a JSON object.

  Returns any

  The serialized block action as a JSON object.

  Memberof

  BlockAction

Static explode

• explode(x, y, z, block): BlockAction

• Creates an explosion at the specified offset from the affected block.

  Parameters

  • x: number

    The x offset.
  • y: number

    The y offset.
  • z: number

    The z offset.
  • block: Block

    The block to be used to replace all blocks affected by the explosion.

  Returns BlockAction

  Static

  Memberof

  BlockAction

Static playSound2d

• playSound2d(sound, volume?, pitch?, pan?): BlockAction

• Plays a sound globally.

  Parameters

  • sound: string

    The sound to play.
  • Optional volume: number = 1

    The volume of the sound.
  • Optional pitch: number = 1

    The pitch of the sound.
  • Optional pan: number = 0

    The pan of the sound.

  Returns BlockAction

  Static

  Memberof

  BlockAction

Static replaceBlock

• replaceBlock(x, y, z, block): BlockAction

• Replaces a block at the specified offset from the affected block with the specified block state.

  Parameters

  • x: number

    The x offset.
  • y: number

    The y offset.
  • z: number

    The z offset.
  • block: Block

    The block to replace the existing block with.

  Returns BlockAction

  Static

  Memberof

  BlockAction

Static runTrigger

• runTrigger(x, y, z, trigger, tickDelay?): BlockAction

• Runs a trigger at the specified offset from the affected block.

  Parameters

  • x: number

    The x offset.
  • y: number

    The y offset.
  • z: number

    The z offset.
  • trigger: string

    The trigger to run.
  • Optional tickDelay: number = 0

    The number of ticks to delay the trigger.

  Returns BlockAction

  Static

  Memberof

  BlockAction

Static setBlockStateParams

• setBlockStateParams(x, y, z, params): BlockAction

• Sets the block state parameters at the specified offset from the affected block.

  Parameters

  • x: number

    The x offset.
  • y: number

    The y offset.
  • z: number

    The z offset.
  • params: any

    The block state parameters to be used.

  Returns BlockAction

  Static

  Memberof

  BlockAction