Global

Members

(constant) BLUE :number

The blue alliance.
Type:
  • number
Source:

(constant) BOTTOM :number

Represents the bottom row of the scoring grid.
Type:
  • number
Source:

(constant) CENTER :number

Center represents the center of the field. Used for the starting position.
Type:
  • number
Source:

(constant) CONE :number

CONE represents a cone in the inventory.
Type:
  • number
Source:

(constant) CUBE :number

CUBE represents a cube in the inventory.
Type:
  • number
Source:

(constant) EMPTY :number

EMPTY represents an empty inventory.
Type:
  • number
Source:

(constant) EVENT_TYPES

Properties:
Name Type Description
PICK_UP_PIECE string An event in which a piece was picked up.
DROP_PIECE string An event in which a piece was dropped.
SCORE_PIECE string An event in which a piece was scored.
DISLODGE_PIECE string An event in which a piece was dislodged from the grid.
EARN_MOBILITY_BONUS string An event in which a robot earns the mobility bonus.
DISABLED string An event in which a robot is disabled.
ENABLED string An event in which a robot is reenabled.
CHARGE_STATION_DOCK string An event in which a robot docks with the charge station.
CHARGE_STATION_ENGAGE string An event in which a robot engages with the charge station.
Source:

(constant) LEFT :number

Left represents the left side of the field. Used for the starting position.
Type:
  • number
Source:

(constant) MIDDLE :number

Represents the middle row of the scoring grid.
Type:
  • number
Source:

(constant) PICKUP

Properties:
Name Type Description
FIELD number The field.
SINGLE number A single game piece.
DOUBLE number A double game piece.
Source:

(constant) POINT_VALUES

Properties:
Name Type Description
AUTO Object The point values for the autonomous period.
Properties
Name Type Description
MOBILITY 3 (3 POINTS) The point value for mobility in autonomous.
GAME_PIECES Object The point values for game pieces in autonomous.
Properties
Name Type Description
TOP 6 (6 POINTS) The point value for a game piece in the top row in autonomous
MIDDLE 4 (4 POINTS) The point value for a game piece in the middle row in autonomous
BOTTOM 3 (3 POINTS) The point value for a game piece in the bottom row in autonomous
DOCKED_NOT_ENGAGED 8 (8 POINTS) The point value for docking in autonomous without engaging the hook.
DOCKED_AND_ENGAGED 12 (12 POINTS) The point value for docking in autonomous with engaging the hook.
TELEOP Object The point values for the teleoperated period.
Properties
Name Type Description
GAME_PIECES Object The point values for game pieces in teleoperated.
Properties
Name Type Description
TOP 5 (5 POINTS) The point value for a game piece in the top row in teleoperated
MIDDLE 3 (3 POINTS) The point value for a game piece in the middle row in teleoperated
BOTTOM 2 (2 POINTS) The point value for a game piece in the bottom row in teleoperated
DOCKED_NOT_ENGAGED 6 (6 POINTS) The point value for docking in teleoperated without engaging the hook.
DOCKED_AND_ENGAGED 10 (10 POINTS) The point value for docking in teleoperated with engaging the hook.
LINK 5 (5 POINTS) The point value for linking the robot to the other robot.
PARK 2 (2 POINTS) The point value for parking the robot.
Source:

(constant) RED :number

The red alliance.
Type:
  • number
Source:
Right represents the right side of the field. Used for the starting position.
Type:
  • number
Source:

(constant) TOP :number

Represents the top row of the scoring grid.
Type:
  • number
Source: