SCDS/FtcRobotControllerSDK
7
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update internal links

Westside Robotics
2021-11-15 16:30:32 -08:00
parent 520e36f863
commit f71ecbc77b
1 changed files with 15 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
Custom-FTC-Blocks-(myBlocks).md

@ -138,7 +138,7 @@ The required **annotation** ```@ExportToBlocks``` has optional fields, which may
### Comment
- The **comment** text appears in a balloon when the Blocks user clicks the blue question-mark icon. Tell the user **how to use your myBlock**.
- Must be entered on a **single line**, with no 'line breaks'. This requirement can be met by **joining text strings**; an example is [[below|https://github.com/WestsideRobotics/FTCmyBlocks/wiki/hardware-example-control-a-servo]].
- Must be entered on a **single line**, with no 'line breaks'. This requirement can be met by **joining text strings**; an example is [[below|https://github.com/FIRST-Tech-Challenge/FtcRobotController/wiki/Custom-FTC-Blocks-(myBlocks)/#hardware-example-control-a-servo]].
- The blue icon will appear only if a custom comment is specified. The Blocks user can add and remove the blue icon, and can edit its text in the (re-sizeable) balloon.
### Tooltip
@ -177,7 +177,7 @@ Do not type or run the following myBlock example. Its dummy inputs simply illus
Notice that the Java **parameters** ```uno```, ```parola``` and ```verita``` have **myBlock labels** ```One```, ```Word``` and ```Truth```. They are allowed to be different.
The **comment** field explains this myBlock to the Blocks user, who can edit or delete the comment. Only for display here, this sample text appears on multiple lines; normally it must be typed as a single line of text or as joined quotes (example [[below|https://github.com/WestsideRobotics/FTCmyBlocks/wiki/hardware-example-control-a-servo]]).
The **comment** field explains this myBlock to the Blocks user, who can edit or delete the comment. Only for display here, this sample text appears on multiple lines; normally it must be typed as a single line of text or as joined quotes (example [[below|https://github.com/FIRST-Tech-Challenge/FtcRobotController/wiki/Custom-FTC-Blocks-(myBlocks)/#hardware-example-control-a-servo]]).
A myBlock **tooltip** should be brief. Note: the four tooltips don't all appear at the same time; each appears with a mouseover. One is custom, three are auto-generated based on input type.
@ -209,7 +209,7 @@ In any case, consider adding **versions** to your myBlock names, such as myGreet
Keep the class name **short and generic**, such as MyBlocks, SampleMyBlocks, Team8604MyBlocks, DrivingMyBlocks, etc. It will contain all or many related myBlocks, not just one myBlock per the simple examples above.
In that single class, each myBlock method must appear <u>after</u> its own annotation ```@ExportToBlocks```. That class may contain other methods that are not myBlocks; omit the annotation before any non-myBlock methods. Such methods might be used to initialize variables, or might be (shared) submethods called by one or more myBlocks. An example is shown [[far below|https://github.com/WestsideRobotics/FTCmyBlocks/wiki/example-non-myblock-methods]].
In that single class, each myBlock method must appear <u>after</u> its own annotation ```@ExportToBlocks```. That class may contain other methods that are not myBlocks; omit the annotation before any non-myBlock methods. Such methods might be used to initialize variables, or might be (shared) submethods called by one or more myBlocks. An example is shown [[far below|https://github.com/FIRST-Tech-Challenge/FtcRobotController/wiki/Custom-FTC-Blocks-(myBlocks)/#example-non-myblock-methods]].
This tutorial has covered these basic requirements so far:
- create/store in **org.firstinspires.ftc.teamcode** folder/package