@minecraft/server-editor
    Preparing search index...

    Class PyramidBrushShapeBeta

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Accessors

    displayName icon id

    Methods

    applySetting calculateBounds createSettingsPane createShape createShapeAsync estimateBlockCount getSettings

    Constructors

    • Beta

      Parameters

      • Optionalsettings: {
            depth?: number;
            height?: number;
            uniform?: boolean;
            width?: number;
            xRotation?: number;
            yRotation?: number;
            zRotation?: number;
        }

      Returns PyramidBrushShape

      Constructs a new instance of the PyramidBrushShape class

    Accessors

    • get displayName(): string
      Beta

      Returns string

    • get icon(): string
      Beta

      Returns string

    • get id(): string
      Beta

      Returns string

    Methods

    • Beta

      Returns BlockBoundingBox

      Object with min and max Vector3 bounds

      Calculates the bounding box of the shape in local coordinates. Used for region allocation before shape placement.

    • Beta

      Parameters

      • OptionalcancelToken: { cancelled: boolean }

        Optional token to cancel the operation. Set cancelled to true to abort.

      • OptionalyieldInterval: number

        Number of blocks to process before yielding. Default is 10000.

      Returns Promise<RelativeVolumeListBlockVolume>

      Promise that resolves to the shape positions as Vector3 array.

      Asynchronously creates the shape, yielding control periodically to avoid timeouts. Use this for large shapes where createShape() may timeout.

    • Beta

      Returns number

      Estimated block count

      Returns a mathematical estimate of the number of blocks in the shape. Used for UI display and validation before shape creation.

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods