Scratch3BoostBlocks

Scratch 3.0 blocks to interact with a LEGO Boost peripheral.

Constructor

new Scratch3BoostBlocks(runtime)

Construct a set of Boost blocks.

Parameters:

Name	Type	Description
`runtime`	Runtime	the Scratch 3.0 runtime.

Members

(static) EXTENSION_ID

(static) TILT_THRESHOLD

runtime :Runtime

The Scratch 3.0 runtime.

Type:

Runtime

Methods

(private) _forEachMotor(motorID, callback)

Call a callback for each motor indexed by the provided motor ID.

Parameters:

Name	Type	Description
`motorID`	MotorID	the ID specifier.
`callback`	function	the function to call with the numeric motor index for each motor.

(private) _getTiltAngle(direction) → {number}

Parameters:

Name	Type	Description
`direction`	TiltDirection	the direction (up, down, left, right) to check.

Returns:

the tilt sensor's angle in the specified direction. Note that getTiltAngle(up) = -getTiltAngle(down) and getTiltAngle(left) = -getTiltAngle(right).

Type: number

(private) _isTilted(direction) → {boolean}

Test whether the tilt sensor is currently tilted.

Parameters:

Name	Type	Description
`direction`	TiltDirection	the tilt direction to test (up, down, left, right, or any).

Returns:

true if the tilt sensor is tilted past a threshold in the specified direction.

Type: boolean

getInfo() → {object}

Returns:

metadata for this extension and its blocks.

Type: object

getMotorPosition(args) → {number}

Parameters:

Name	Type	Description
`args`	object	the block's arguments.

Returns:

returns the motor's position.

Type: number

getTiltAngle(args) → {number}

Properties:

Name	Type	Description
`TILT_DIRECTION`	TiltDirection	the direction (up, down, left, right) to check.

Parameters:

Name	Type	Description
`args`	object	the block's arguments.

Returns:

the tilt sensor's angle in the specified direction. Note that getTiltAngle(up) = -getTiltAngle(down) and getTiltAngle(left) = -getTiltAngle(right).

Type: number

isTilted(args) → {boolean}

Properties:

Name	Type	Description
`TILT_DIRECTION_ANY`	TiltDirection	the tilt direction to test (up, down, left, right, or any).

Test whether the tilt sensor is currently tilted.

Parameters:

Name	Type	Description
`args`	object	the block's arguments.

Returns:

true if the tilt sensor is tilted past a threshold in the specified direction.

Type: boolean

motorOff(args) → {Promise}

Properties:

Name	Type	Description
`MOTOR_ID`	MotorID	the motor(s) to deactivate.

Turn specified motor(s) off.

Parameters:

Name	Type	Description
`args`	object	the block's arguments.

Returns:

a Promise that resolves after some delay.

Type: Promise

motorOn(args) → {Promise}

Properties:

Name	Type	Description
`MOTOR_ID`	MotorID	the motor(s) to activate.

Turn specified motor(s) on indefinitely.

Parameters:

Name	Type	Description
`args`	object	the block's arguments.

Returns:

a Promise that resolves after some delay.

Type: Promise

motorOnFor(args) → {Promise}

Properties:

Name	Type	Description
`MOTOR_ID`	MotorID	the motor(s) to activate.
`DURATION`	int	the amount of time to run the motors.

Turn specified motor(s) on for a specified duration.

Parameters:

Name	Type	Description
`args`	object	the block's arguments.

Returns:

a promise which will resolve at the end of the duration.

Type: Promise

motorOnForRotation(args) → {Promise}

Properties:

Name	Type	Description
`MOTOR_ID`	MotorID	the motor(s) to activate.
`ROTATION`	int	the amount of full rotations to turn the motors.

Turn specified motor(s) on for a specified rotation in full rotations.

Parameters:

Name	Type	Description
`args`	object	the block's arguments.

Returns:

a promise which will resolve at the end of the duration.

Type: Promise

seeingColor(args) → {boolean}

A boolean reporter function, for whether the vision sensor is detecting a certain color.

Parameters:

Name	Type	Description
`args`	object	the block's arguments.

Returns:

true when the color sensor senses the specified color.

Type: boolean

setLightHue(args) → {Promise}

Properties:

Name	Type	Description
`HUE`	number	the hue to set, in the range [0,100].

Set the LED's hue.

Parameters:

Name	Type	Description
`args`	object	the block's arguments.

Returns:

a Promise that resolves after some delay.

Type: Promise

setMotorDirection(args) → {Promise}

Properties:

Name	Type	Description
`MOTOR_ID`	MotorID	the motor(s) to be affected.
`MOTOR_DIRECTION`	MotorDirection	the new direction for the motor(s).

Set the direction of rotation for specified motor(s). If the direction is 'reverse' the motor(s) will be reversed individually.

Parameters:

Name	Type	Description
`args`	object	the block's arguments.

Returns:

returns a promise to make sure the block yields.

Type: Promise

setMotorPower(args) → {Promise}

Properties:

Name	Type	Description
`MOTOR_ID`	MotorID	the motor(s) to be affected.
`POWER`	int	the new power level for the motor(s).

Set the power level of the specified motor(s).

Parameters:

Name	Type	Description
`args`	object	the block's arguments.

Returns:

returns a promise to make sure the block yields.

Type: Promise

whenColor(args) → {boolean}

Edge-triggering hat function, for when the vision sensor is detecting a certain color.

Parameters:

Name	Type	Description
`args`	object	the block's arguments.

Returns:

true when the color sensor senses the specified color.

Type: boolean

whenTilted(args) → {boolean}

Properties:

Name	Type	Description
`TILT_DIRECTION_ANY`	TiltDirection	the tilt direction to test (up, down, left, right, or any).

Test whether the tilt sensor is currently tilted.

Parameters:

Name	Type	Description
`args`	object	the block's arguments.

Returns:

true if the tilt sensor is tilted past a threshold in the specified direction.

Type: boolean