Python#

The VEX AIM Python API Reference explains what each command, method, and function does, what inputs it uses, what it returns, and how it can be used in a project.

Use this reference when you want to understand a command before adding it to a project, check what values it accepts or returns, or compare related commands in a category.

Python commands are used in VEXcode AIM Python projects. Blocks projects use the Blocks API section instead.

How to Read a Method Entry#

Most Python entries include the following parts:

Command name - The official name of the command, method, or function.
Description - Explains what the command does and when it is useful.
Usage - Shows the syntax used to write the command in code.
Parameters - Lists the inputs the command accepts and explains what each one does.
Return value - Explains what the command reports back, if it returns a value.
Example code - Shows one way the command can be used in a project.

Common Python API Elements#

Element	What it means
Method	A command called on an object such as `robot.move_at(…)`.
Function	A command called directly, such as `wait(…)` or `print(…)`.
Parameter	A value passed into a method or function to control what it does.
Optional parameter	A parameter that can be left out so the default behavior is used.
Return value	A value a command reports back, such as a number, text, or Boolean.

Basic Python Vocabulary#

Term	What it means
Variable	A name that stores a value, such as `speed = 50`.
String	Text inside quotes, such as `“Hello”`.
Integer	A positive or negative number, such as `90`.
Float	A number with a decimal, such as `25.5`.
Boolean	A value that is either `True` or `False`.
Argument	A value passed into a method or function call, such as `0` in `robot.move_at(0)`.

Example Method Entry#

move_at#

move_at moves the robot forever at a specific angle. The robot will continue to move until it is given another action, like moving at a different angle, turning, or stopping.

Usage:
robot.move_at(angle, velocity, units)

Parameters	Description
`angle`	The angle, in degrees, that the robot moves. This can be an integer or decimal from -360 to 360.
`velocity`	Optional. The velocity to move with from 0% to 100% when using `PERCENT`, or from 0 to 200 millimeters per second when using `MMPS`. This can be an integer or decimal. If no velocity is provided, the robot moves at the current move velocity.
`units`	Optional. The velocity unit: `PERCENT` (default) or `MMPS` (millimeters per second).

# Move forward
robot.move_at(0)