Help is available for each individual block or command in VEXcode, showing what they do and how to use them.
Accessing Blocks Help
To open help for a block, select the Help icon.
Select a block in the toolbox.
The Help will open for that block.
The Help will tell you:
- What the block does.
- What parameters the block can use.
- An example of the block in use.
To lock the Help for a particular block, select the Lock icon in the upper left corner of the Help window. Once locked, the Help will remain on the same entry until it is unlocked.
This is helpful when trying to recreate a blocks example in the workspace, so you can continually view the reference example while building the project.
To view the Help for a different block, select the Lock icon again to unlock it, then select a block.
You can also access the Help for a block that is in the Workspace.
Right-click on the block to open the Context Menu, then select Block Help.
Accessing Python Help
To open Help for a command, select the Help icon.
Select a command in the toolbox.
The Help will open for that method.
The Help will tell you:
- What the method does.
- What parameters the method can use and what order to write them.
- An example of the method in use.
- Note: Python examples are provided in copyable code snippets. Select the Copy button in the bottom right of the example to copy the code to paste into the workspace.
To lock the Help for a particular command, select the Lock icon in the upper left corner of the Help window. Once locked, the Help will remain on the same entry until it is unlocked.
To view the Help for a different command, select the Lock icon again to unlock it, then select a command.
You can also access the Help for a command that is in the Workspace.
Right-click on the command's method to open the Context Menu, then select Command Help.