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

    Class SculkSpreader

    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

    Constructors

    constructor

    Properties

    maxCharge

    Methods

    addCursorsWithOffset getCursorPosition getNumberOfCursors getTotalCharge

    Constructors

    Properties

    maxCharge: number

    Gets the maximum charge of a sculk spreader.

    This property can throw when used.

    This property can't be read in early-execution mode.

    Methods

    • Parameters

      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.

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

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

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

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

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

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

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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods