Welcome to the API Reference Site for VEXcode VR#

Discover everything you need to start coding with VEXcode VR, using both Blocks and Python. This guide will help you navigate the site and make the most of the available resources.

Site Navigation#

Our API Reference is designed for easy access to all necessary resources:

Language Navigation: On the left side of the page, you will find a sidebar with each available language. This allows you to quickly navigate to the specific language, toolbox section, or specific class you need.
Platform Navigation: At the top of the page, there is a bar for switching between VEX’s different platforms.
Page Navigation - On the right side of the page, there will be a navigation section for fast access to all the page’s sections. This allows you to quickly see all of the different commands, methods, or blocks that are available to view on the page.

API Sections#

Blocks: Explore VEXcode VR Standard blocks, including detailed descriptions, parameters, and usage examples.
Switch: Access information for Switch Blocks and learn how to implement them in your projects.
Python: Explore VEXcode VR Standard Python commands, with in-depth descriptions, parameters, and usage examples.
Playgrounds: Find information on all VEXcode VR Playgrounds. Standard Playgrounds have a single page detailing variations in field measurements or robot configurations. Non-Standard Playgrounds (such as Virtual Skills or Rover Rescue) include additional pages detailing unique fields, robots, and any new commands or blocks specific to that Playground.

How to Use the API Reference#

Select Your Playground: Visit the Playgrounds page to identify whether you’re using a Standard or Non-Standard Playground and review any important details.
Choose Your Language: Decide whether you want to use Blocks or Python for your project.
- For Blocks, navigate to the Blocks page.
- For Python, navigate to the Python page.
Browse or Search: Use the navigation menu or search bar to locate specific commands or blocks.
Read the Descriptions: Each API function includes a description that explains its purpose, parameters, and any important notes.
Review the Examples:
- Blocks: Visual examples of blocks will help you understand how to use them in your projects.
- Python: Code snippets show how to write commands in VEXcode VR, with comments to explain each step:
```
def main():
    # Move the Drivetrain forward for 500 MM.
    drivetrain.drive_for(FORWARD, 500, MM)
```
Experiment and Modify: Try out the example code in your projects. Modify it to fit your needs and observe the effects.

Tips for Success#

Start Simple: Begin with basic projects to get comfortable with VEXcode.
Read the API Reference: Explore the API reference to understand the available functions and their operations.
Practice Regularly: The more you code, the more proficient you’ll become with the platform.

Happy coding, and welcome to VEXcode VR!

Welcome to the API Reference Site for VEXcode VR#

Site Navigation#

API Sections#

How to Use the API Reference#

Tips for Success#

Available API Sections#