Welcome to the VEXcode VR API Reference Site#

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.

API Sections#

How to Use the API Reference#

  1. Select Your Playground: Visit the Playgrounds page to identify whether you’re using a Standard or Non-Standard Playground and review any important details.

  2. 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.

  3. Browse or Search: Use the navigation menu or search bar to locate specific commands or blocks.

  4. Read the Descriptions: Each API function includes a description that explains its purpose, parameters, and any important notes.

  5. Review the Examples:

    • Blocks: Visual examples of blocks will help you understand how to use them in your projects.

    drive_for_example

    • 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)
    
    
  6. 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!

Available API Sections#