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

    Class SculkSpreaderBeta

    Implements a class that can be used for testing sculk spreading behaviors. This sculk spreader class can drive the growth of sculk around a particular block.

    Index

    Properties

    maxCharge

    Methods

    addCursorsWithOffset getCursorPosition getNumberOfCursors getTotalCharge

    Properties

    maxCharge: number

    Gets the maximum charge of a sculk spreader.

    This property can throw when used.

    Methods

    • Beta

      Parameters

      • offset: Vector3
      • charge: number

      Returns void

      Adds a cursor - which is a notional waypoint that the sculk will spread in the direction of.

      This function can't be called in read-only mode.

    • Beta

      Parameters

      • index: number

      Returns Vector3

      Retrieves the current position of the specified cursor.

      This function can't be called in read-only mode.

      This function can throw errors.

    • Beta

      Returns number

      Returns a number of overall cursors for this sculk spreader.

      This function can't be called in read-only mode.

      This function can throw errors.

    • Beta

      Returns number

      Gets the total current charge of the sculk spreader.

      This function can't be called in read-only mode.

      This function can throw errors.

    Settings

    Member Visibility

    On This Page

    Properties
    Methods