JSPrismarine

API reference / @jsprismarine/entity-brains / IsInWaterSensor

Class: IsInWaterSensor ​

Defined in: sensing/sensors.ts:164

Java's IsInWaterSensor: holds the IS_IN_WATER unit while the mob is submerged.

Extends ​

Constructors ​

Constructor ​

new IsInWaterSensor(scanRate?): IsInWaterSensor

Defined in: sensing/sensor.ts:33

Parameters ​

scanRate? ​

number = DEFAULT_SCAN_RATE

Returns ​

IsInWaterSensor

Inherited from ​

Sensor.constructor

Properties ​

name ​

readonly name: "IsInWaterSensor" = 'IsInWaterSensor'

Defined in: sensing/sensors.ts:165

The Java class name, which is what a debug read-out shows.

Overrides ​

Sensor.name

requires ​

readonly requires: readonly MemoryModuleType<unknown>[]

Defined in: sensing/sensors.ts:166

Every memory the sensor writes. The brain registers each one when the sensor is added.

Overrides ​

Sensor.requires

scanRate ​

readonly scanRate: number = DEFAULT_SCAN_RATE

Defined in: sensing/sensor.ts:33

Inherited from ​

Sensor.scanRate

Methods ​

randomlyDelayStart() ​

randomlyDelayStart(randomInt): void

Defined in: sensing/sensor.ts:36

Java's randomlyDelayStart: offsets the first scan into [0, scanRate).

Parameters ​

randomInt ​

(bound) => number

Returns ​

void

Inherited from ​

Sensor.randomlyDelayStart

tick() ​

tick(context): void

Defined in: sensing/sensor.ts:41

Counts down and scans when the countdown reaches zero.

Parameters ​

context ​

BrainContext

Returns ​

void

Inherited from ​

Sensor.tick