Class RobotInstruction`Abstract`

Base class for instructions that can be executed by a robot controller.

Remarks

It is not possible to create custom/scripted robot instructions. Instead, create a custom component that extends

See

and use the
to command the robot controller to execute it.

Hierarchy (View Summary)

RobotInstruction

Index

Accessors

Methods

Accessors

program

get program(): null | RobotProgram
The program to which the instruction has been assigned.

Returns null | RobotProgram
Remarks
If the program is null then the instruction hasn't been added to a program.
set program(value: null | RobotProgram): void
Parameters
- value: null | RobotProgram
Returns void

Methods

`Abstract`execute

execute(controller: RobotControllerComponent): Future<any>
Executes the instruction.
Parameters
- controller: RobotControllerComponent
  The robot controller on which the instruction is to be executed.
Returns Future<any>
The future that is resolved once the instruction has been executed.

Remarks
This function is called by the program when the robot controller commands it to execute.

`Abstract`label

label(units: InspectorUnits): string
The label for the instruction, as it is to be displayed in the inspector.
Parameters
- units: InspectorUnits
  The unit settings for the inspector.
Returns string
The label.