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.

Constructors

new SculkSpreader()

private new SculkSpreader(): SculkSpreader

Returns

SculkSpreader

Properties

maxCharge

readonly maxCharge: number

Remarks

Gets the maximum charge of a sculk spreader.

Throws

This property can throw when used.

Methods

addCursorsWithOffset()

addCursorsWithOffset(offset, charge): void

Parameters

Parameter	Type
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): Vector3

Parameters

Parameter	Type
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

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

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.