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

#Properties

#maxCharge

readonly maxCharge: number

Beta

#Remarks

获取幽匿蔓延器的最大能量值。

Gets the maximum charge of a sculk spreader.

#Throws

This property can throw when used.

#Methods

#addCursorsWithOffset()

addCursorsWithOffset(offset, charge): void

World Mutation 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.

---

#getCursorPosition()

getCursorPosition(index): Vector3

World Mutation Beta

#Parameters

#index

number

#Returns

Vector3

#Remarks

获取指定游标的当前位置。

Retrieves the current position of the specified cursor.

#Throws

This function can throw errors.

---

#getNumberOfCursors()

getNumberOfCursors(): number

World Mutation Beta

#Returns

number

#Remarks

返回此幽匿蔓延器的游标总数。

Returns a number of overall cursors for this sculk spreader.

#Throws

This function can throw errors.

---

#getTotalCharge()

getTotalCharge(): number

World Mutation Beta

#Returns

number

#Remarks

获取幽匿蔓延器当前的总能量值。

Gets the total current charge of the sculk spreader.

#Throws

This function can throw errors.