Class SculkSpreader`Beta`

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

Methods

addCursorsWithOffset getCursorPosition getNumberOfCursors getTotalCharge

Properties

`Readonly` `Beta`maxCharge

maxCharge: number

Remarks

Gets the maximum charge of a sculk spreader.

Throws

This property can throw when used.

Methods

addCursorsWithOffset

addCursorsWithOffset(offset: Vector3, charge: number): void
Beta
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

getCursorPosition(index: number): Vector3
Beta
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

getNumberOfCursors(): number
Beta
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

getTotalCharge(): number
Beta
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.