Case 22075: Controller JSDoc update
Showing the changes to interface/src/Application.cpp (1 of 13 files). Show all
Unified · Split
| @@ -664,9 +664,10 @@ private: · 663 unmodified lines | ||
| 664 | 664 | |
| 665 | 665 | /**jsdoc |
| 666 | 666 | * <p>The <code>Controller.Hardware.Application</code> object has properties representing Interface's state. The property |
| 667 | − * values are integer IDs, uniquely identifying each output. <em>Read-only.</em> These can be mapped to actions or functions or | |
| 668 | − * <code>Controller.Standard</code> items in a {@link RouteObject} mapping (e.g., using the {@link RouteObject#when} method). | |
| 669 | − * Each data value is either <code>1.0</code> for "true" or <code>0.0</code> for "false".</p> | |
| 667 | + * values are integer IDs, uniquely identifying each output. <em>Read-only.</em></p> | |
| 668 | + * <p>These states can be mapped to actions or functions or <code>Controller.Standard</code> items in a {@link RouteObject} | |
| 669 | + * mapping (e.g., using the {@link RouteObject#when} method). Each data value is either <code>1.0</code> for "true" or | |
| 670 | + * <code>0.0</code> for "false".</p> | |
| 670 | 671 | * <table> |
| 671 | 672 | * <thead> |
| 672 | 673 | * <tr><th>Property</th><th>Type</th><th>Data</th><th>Description</th></tr> |
| @@ -680,13 +681,17 @@ private: · 7 unmodified lines | ||
| 680 | 681 | * <tr><td><code>CameraIndependent</code></td><td>number</td><td>number</td><td>The camera is in independent mode.</td></tr> |
| 681 | 682 | * <tr><td><code>CameraEntity</code></td><td>number</td><td>number</td><td>The camera is in entity mode.</td></tr> |
| 682 | 683 | * <tr><td><code>InHMD</code></td><td>number</td><td>number</td><td>The user is in HMD mode.</td></tr> |
| 683 | − * <tr><td><code>AdvancedMovement</code></td><td>number</td><td>number</td><td>Advanced movement controls are enabled. | |
| 684 | − * </td></tr> | |
| 684 | + * <tr><td><code>AdvancedMovement</code></td><td>number</td><td>number</td><td>Advanced movement (walking) controls are | |
| 685 | + * enabled.</td></tr> | |
| 686 | + * <tr><td><code>StrafeEnabled</code></td><td>number</td><td>number</td><td>Strafing is enabled</td></tr> | |
| 685 | 687 | * <tr><td><code>LeftHandDominant</code></td><td>number</td><td>number</td><td>Dominant hand set to left.</td></tr> |
| 686 | 688 | * <tr><td><code>RightHandDominant</code></td><td>number</td><td>number</td><td>Dominant hand set to right.</td></tr> |
| 687 | 689 | * <tr><td><code>SnapTurn</code></td><td>number</td><td>number</td><td>Snap turn is enabled.</td></tr> |
| 688 | 690 | * <tr><td><code>Grounded</code></td><td>number</td><td>number</td><td>The user's avatar is on the ground.</td></tr> |
| 689 | 691 | * <tr><td><code>NavigationFocused</code></td><td>number</td><td>number</td><td><em>Not used.</em></td></tr> |
| 692 | + * <tr><td><code>PlatformWindows</code></td><td>number</td><td>number</td><td>The operating system is Windows.</td></tr> | |
| 693 | + * <tr><td><code>PlatformMac</code></td><td>number</td><td>number</td><td>The operating system is Mac.</td></tr> | |
| 694 | + * <tr><td><code>PlatformAndroid</code></td><td>number</td><td>number</td><td>The operating system is Android.</td></tr> | |
| 690 | 695 | * </tbody> |
| 691 | 696 | * </table> |
| 692 | 697 | * @typedef {object} Controller.Hardware-Application |