JSPrismarine

API reference / @jsprismarine/entity-brains / MobSensor

Class: MobSensor ​

Defined in: sensing/sensors.ts:221

Java's MobSensor: holds a boolean memory while a mob matching a test is nearby.

The only registration is armadillo_scare_detected, built as new MobSensor(5, Armadillo::isScaredBy, Armadillo::canStayRolledUp, DANGER_DETECTED_RECENTLY, 80).

Extends ​

Constructors ​

Constructor ​

new MobSensor(scanRate, mobTest, readyTest, toSet, memoryTimeToLive): MobSensor

Defined in: sensing/sensors.ts:225

Parameters ​

scanRate ​

number

mobTest ​

(context, entity) => boolean

readyTest ​

(context) => boolean

toSet ​

MemoryModuleType<boolean>

memoryTimeToLive ​

number

Returns ​

MobSensor

Overrides ​

Sensor.constructor

Properties ​

name ​

readonly name: "MobSensor" = 'MobSensor'

Defined in: sensing/sensors.ts:222

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:223

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