JSPrismarine

API reference / @jsprismarine/entity-brains / Sensor

Abstract Class: Sensor ​

Defined in: sensing/sensor.ts:24

A sensor. Java's abstract Sensor.

Sensor.tick is final in Java and is here too: it owns the countdown, and Sensor.doTick is the hook.

Extended by ​

Constructors ​

Constructor ​

new Sensor(scanRate?): Sensor

Defined in: sensing/sensor.ts:33

Parameters ​

scanRate? ​

number = DEFAULT_SCAN_RATE

Returns ​

Sensor

Properties ​

name ​

abstract readonly name: string

Defined in: sensing/sensor.ts:26

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

requires ​

abstract readonly requires: readonly MemoryModuleType<unknown>[]

Defined in: sensing/sensor.ts:29

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

scanRate ​

readonly scanRate: number = DEFAULT_SCAN_RATE

Defined in: sensing/sensor.ts:33

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

tick() ​

tick(context): void

Defined in: sensing/sensor.ts:41

Counts down and scans when the countdown reaches zero.

Parameters ​

context ​

BrainContext

Returns ​

void