Class SculkSpreader

Index

Constructors

Properties

Methods

addCursorsWithOffset getCursorPosition getNumberOfCursors getTotalCharge

Constructors

`Private`constructor

new SculkSpreader(): SculkSpreader
Returns SculkSpreader

Properties

`Readonly`maxCharge

maxCharge: number

Throws

This property can throw errors.

World Ready

This property can't be read in early-execution mode.

Methods

addCursorsWithOffset

addCursorsWithOffset(offset: Vector3, charge: number): void
Parameters
- offset: Vector3
- charge: number
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

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

getCursorPosition

getCursorPosition(index: number): Vector3
Parameters
- index: number
Returns Vector3
Remarks
Write Privilege
This function can't be called in read-only 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
Write Privilege
This function can't be called in read-only 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
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

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