Class SculkSpreader

ReadonlymaxCharge

addCursorsWithOffset

• addCursorsWithOffset(offset: Vector3, charge: number): void

  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 restricted-execution mode.

  World Ready

  This function can't be called in early-execution mode.

getCursorPosition

• getCursorPosition(index: number): Vector3

  Parameters

  • index: number

  Returns Vector3

  Remarks

  Retrieves the current position of the specified cursor.

  This function can't be called in restricted-execution mode.

  Throws

  This function can throw errors.

  World Ready

  This function can't be called in early-execution mode.

getNumberOfCursors

• getNumberOfCursors(): number

  Returns number

  Remarks

  Returns a number of overall cursors for this sculk spreader.

  This function can't be called in restricted-execution mode.

  Throws

  This function can throw errors.

  World Ready

  This function can't be called in early-execution mode.

getTotalCharge

• getTotalCharge(): number

  Returns number

  Remarks

  Gets the total current charge of the sculk spreader.

  This function can't be called in restricted-execution mode.

  Throws

  This function can throw errors.

  World Ready

  This function can't be called in early-execution mode.