@minecraft/server-gametest / SculkSpreader
Class: SculkSpreader
Defined in: @minecraft/server-gametest/index.d.ts:415
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.
Properties
maxCharge
readonlymaxCharge:number
Defined in: @minecraft/server-gametest/index.d.ts:423
Beta
Remarks
Gets the maximum charge of a sculk spreader.
Throws
This property can throw when used.
Methods
addCursorsWithOffset()
addCursorsWithOffset(
offset,charge):void
Defined in: @minecraft/server-gametest/index.d.ts:432
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):Vector3
Defined in: @minecraft/server-gametest/index.d.ts:441
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
Defined in: @minecraft/server-gametest/index.d.ts:450
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
Defined in: @minecraft/server-gametest/index.d.ts:459
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.