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.

Hierarchy

  • SculkSpreader

Properties

maxCharge

Methods

addCursorsWithOffset getCursorPosition getNumberOfCursors getTotalCharge

Constructors

Private constructor

Properties

Readonly maxCharge

maxCharge: number

Remarks

Gets the maximum charge of a sculk spreader.

Throws

This property can throw when used.

Methods

addCursorsWithOffset

  • Parameters

    • offset: Vector3
    • charge: number

    Returns void

    Remarks

    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.

getCursorPosition

  • Parameters

    • index: number

    Returns Vector3

    Remarks

    Retrieves the current position of the specified cursor.

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

    Throws

    This function can throw errors.

getNumberOfCursors

  • Returns number

    Remarks

    Returns a number of overall cursors for this sculk spreader.

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

    Throws

    This function can throw errors.

getTotalCharge

  • Returns number

    Remarks

    Gets the total current charge of the sculk spreader.

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

    Throws

    This function can throw errors.

Settings

Member Visibility

Theme

On This Page