VEXcode VR API Reference#

Welcome to the VEXcode VR API Reference. This site explains the Blocks and Python commands available in VEXcode VR, along with Playground and Robot-specific information.

Use this reference to learn what a command does, what information it needs, what it reports or returns, and how it can be used in a project.

API Sections#

  • Blocks - Learn about the blocks available in VEXcode VR, including what each block does, what its inputs mean, and how it can be used in a project.

  • Python - Learn about the Python methods, functions, parameters, return values, and examples used in VEXcode VR.

  • Playgrounds - Find setup details, field information, and robot links for VEXcode VR Playgrounds.

  • Robots - Find Robot-specific Blocks and Python pages for the robots used across VEXcode VR Playgrounds.

  • VEXcode Tutorials - Find tutorials and supporting resources for learning how to use VEXcode VR.

Playgrounds and Robots in VR#

The Playgrounds section helps you choose the environment you are working in. Use those pages to see what each Playground includes, which robot it uses, and where to find Playground-specific details before you start coding.

The Robots section helps you choose the robot you are coding with. Use those pages to find robot-specific Blocks and Python entries, along with the Playgrounds where each robot appears.

How to Use This Reference#

  1. Choose the Playground or Robot you are using, if your project depends on Robot-specific features.

  2. Choose the section for the coding language or resource you are using.

  3. Use the sidebar or search bar to find a device, category, block, command, method, or Robot-specific page.

  4. Read the description to understand what the command does and when it is useful.

  5. Check the parameters to see what inputs are needed and what options are available.

  6. Review the example to see one way the command can be used in a project.

For text-based examples in Python, select the Copy button to copy the example, then paste it into your coding environment.

Page Navigation#

This site includes several navigation tools:

  • Sidebar navigation - Use the left sidebar to move between API sections, devices, categories, Playgrounds, Robots, and pages.

  • Platform navigation - Use the platform navigation to switch to API references for other VEX platforms.

  • Page navigation - Use the right-side page navigation to jump to sections on the current page.

Tips for Using the API#

  • Start with the Playground or Robot you are using so you can find the correct Robot-specific blocks and methods.

  • Read the description before copying an example so you understand what the command is meant to do.

  • Check parameter tables carefully. Small changes to inputs can change how the VR Robot behaves.

  • Use examples as a starting point, then change values, directions, names, or options to match your own project.

On this page