Script API - v1.26.10.22
    Preparing search index...

    Class CuboidBrushShape

    Base for creating new brush shapes

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Accessors

    displayName icon id

    Methods

    applySetting calculateBounds createSettingsPane createShape createShapeAsync estimateBlockCount getSettings

    Constructors

    • Parameters

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

      Returns CuboidBrushShape

      Constructs a new instance of the CuboidBrushShape class

    Accessors

    • get displayName(): string

      Returns string

    • get icon(): string

      Returns string

    • get id(): string

      Returns string

    Methods

    • 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.

      This function can't be called in early-execution mode.

    • 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.

      This function can't be called in early-execution mode.

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods