Showing the changes to interface/src/scripting/ControllerScriptingInterface.h (1 of 1 file). Show all
Unified · Split
| @@ -28,16 +28,18 @@ class ScriptEngine; · 27 unmodified lines | ||
| 28 | 28 | /**jsdoc |
| 29 | 29 | * The <code>Controller</code> API provides facilities to interact with computer and controller hardware. |
| 30 | 30 | * |
| 31 | − * <h4>Facilities</h4> | |
| 31 | + * <h3>Facilities</h3> | |
| 32 | 32 | * |
| 33 | − * <p>Properties</p> | |
| 33 | + * <h4>Properties</h4> | |
| 34 | + * <p>Get <code>Controller</code> property trees.</p> | |
| 34 | 35 | * <ul> |
| 35 | 36 | * <li>{@link Controller.getActions|getActions}</li> |
| 36 | 37 | * <li>{@link Controller.getHardware|getHardware}</li> |
| 37 | 38 | * <li>{@link Controller.getStandard|getStandard}</li> |
| 38 | 39 | * </ul> |
| 39 | 40 | * |
| 40 | − * <p>Mappings</p> | |
| 41 | + * <h4>Mappings</h4> | |
| 42 | + * <p>Create and enable or disable <code>Controller</code> mappings.</p> | |
| 41 | 43 | * <ul> |
| 42 | 44 | * <li>{@link Controller.disableMapping|disableMapping}</li> |
| 43 | 45 | * <li>{@link Controller.enableMapping|enableMapping}</li> |
| @@ -46,7 +48,8 @@ class ScriptEngine; · 2 unmodified lines | ||
| 46 | 48 | * <li>{@link Controller.parseMapping|parseMapping}</li> |
| 47 | 49 | * </ul> |
| 48 | 50 | * |
| 49 | − * <p>Input, Hardware, and Action Reflection</p> | |
| 51 | + * <h4>Input, Hardware, and Action Reflection</h4> | |
| 52 | + * <p>Information on the devices and actions available.</p> | |
| 50 | 53 | * <ul> |
| 51 | 54 | * <li>{@link Controller.findAction|findAction}</li> |
| 52 | 55 | * <li>{@link Controller.findDevice|findDevice}</li> |
| @@ -58,7 +61,8 @@ class ScriptEngine; · 5 unmodified lines | ||
| 58 | 61 | * <li>{@link Controller.getRunningInputDevices|getRunningInputDevices}</li> |
| 59 | 62 | * </ul> |
| 60 | 63 | * |
| 61 | − * <p>Input, Hardware, and Action Signals</p> | |
| 64 | + * <h4>Input, Hardware, and Action Signals</h4> | |
| 65 | + * <p>Notifications of device and action events.</p> | |
| 62 | 66 | * <ul> |
| 63 | 67 | * <li>{@link Controller.actionEvent|actionEvent}</li> |
| 64 | 68 | * <li>{@link Controller.hardwareChanged|hardwareChanged}</li> |
| @@ -66,7 +70,8 @@ class ScriptEngine; · 1 unmodified line | ||
| 66 | 70 | * <li>{@link Controller.inputEvent|inputEvent}</li> |
| 67 | 71 | * </ul> |
| 68 | 72 | * |
| 69 | − * <p>Mouse, Keyboard, and Touch Signals</p> | |
| 73 | + * <h4>Mouse, Keyboard, and Touch Signals</h4> | |
| 74 | + * <p>Notifications of mouse, keyboard, and touch events.</p> | |
| 70 | 75 | * <ul> |
| 71 | 76 | * <li>{@link Controller.keyPressEvent|keyPressEvent}</li> |
| 72 | 77 | * <li>{@link Controller.keyReleaseEvent|keyReleaseEvent}</li> |
| @@ -80,29 +85,32 @@ class ScriptEngine; · 7 unmodified lines | ||
| 80 | 85 | * <li>{@link Controller.wheelEvent|wheelEvent}</li> |
| 81 | 86 | * </ul> |
| 82 | 87 | * |
| 83 | − * <p>Control Capturing</p> | |
| 88 | + * <h4>Control Capturing</h4> | |
| 89 | + * <p>Disable and enable the processing of mouse and touch events.</p> | |
| 84 | 90 | * <ul> |
| 85 | 91 | * <li>{@link Controller.captureMouseEvents|captureMouseEvents}</li> |
| 86 | − * <li>{@link Controller.captureTouchEvents|captureTouchEvents}</li> | |
| 87 | 92 | * <li>{@link Controller.captureWheelEvents|captureWheelEvents}</li> |
| 93 | + * <li>{@link Controller.captureTouchEvents|captureTouchEvents}</li> | |
| 88 | 94 | * <li>{@link Controller.releaseMouseEvents|releaseMouseEvents}</li> |
| 89 | − * <li>{@link Controller.releaseTouchEvents|releaseTouchEvents}</li> | |
| 90 | 95 | * <li>{@link Controller.releaseWheelEvents|releaseWheelEvents}</li> |
| 96 | + * <li>{@link Controller.releaseTouchEvents|releaseTouchEvents}</li> | |
| 91 | 97 | * </ul> |
| 92 | 98 | * |
| 93 | − * <p>Action Capturing</p> | |
| 99 | + * <h4>Action Capturing</h4> | |
| 100 | + * <p>Disable and enable controller actions.</p> | |
| 94 | 101 | * <ul> |
| 95 | 102 | * <li>{@link Controller.captureActionEvents|captureActionEvents}</li> |
| 96 | − * <li>{@link Controller.captureEntityClickEvents|captureEntityClickEvents}</li> | |
| 97 | − * <li>{@link Controller.captureJoystick|captureJoystick}</li> | |
| 98 | 103 | * <li>{@link Controller.captureKeyEvents|captureKeyEvents}</li> |
| 104 | + * <li>{@link Controller.captureJoystick|captureJoystick}</li> | |
| 105 | + * <li>{@link Controller.captureEntityClickEvents|captureEntityClickEvents}</li> | |
| 99 | 106 | * <li>{@link Controller.releaseActionEvents|releaseActionEvents}</li> |
| 100 | − * <li>{@link Controller.releaseEntityClickEvents|releaseEntityClickEvents}</li> | |
| 101 | − * <li>{@link Controller.releaseJoystick|releaseJoystick}</li> | |
| 102 | 107 | * <li>{@link Controller.releaseKeyEvents|releaseKeyEvents}</li> |
| 108 | + * <li>{@link Controller.releaseJoystick|releaseJoystick}</li> | |
| 109 | + * <li>{@link Controller.releaseEntityClickEvents|releaseEntityClickEvents}</li> | |
| 103 | 110 | * </ul> |
| 104 | 111 | * |
| 105 | − * <p>Controller and Action Values</p> | |
| 112 | + * <h4>Controller and Action Values</h4> | |
| 113 | + * <p>Get the current value of controller outputs and actions.</p> | |
| 106 | 114 | * <ul> |
| 107 | 115 | * <li>{@link Controller.getValue|getValue}</li> |
| 108 | 116 | * <li>{@link Controller.getAxisValue|getAxisValue}</li> |
| @@ -110,7 +118,8 @@ class ScriptEngine; · 1 unmodified line | ||
| 110 | 118 | * <li>{@link Controller.getActionValue|getActionValue}</li> |
| 111 | 119 | * </ul> |
| 112 | 120 | * |
| 113 | − * <p>Haptics</p> | |
| 121 | + * <h4>Haptics</h4> | |
| 122 | + * <p>Trigger haptic pulses.</p> | |
| 114 | 123 | * <ul> |
| 115 | 124 | * <li>{@link Controller.triggerHapticPulse|triggerHapticPulse}</li> |
| 116 | 125 | * <li>{@link Controller.triggerHapticPulseOnDevice|triggerHapticPulseOnDevice}</li> |
| @@ -118,20 +127,23 @@ class ScriptEngine; · 1 unmodified line | ||
| 118 | 127 | * <li>{@link Controller.triggerShortHapticPulseOnDevice|triggerShortHapticPulseOnDevice}</li> |
| 119 | 128 | * </ul> |
| 120 | 129 | * |
| 121 | − * <p>Display Information</p> | |
| 130 | + * <h4>Display Information</h4> | |
| 131 | + * <p>Get information on the display.</p> | |
| 122 | 132 | * <ul> |
| 123 | 133 | * <li>{@link Controller.getViewportDimensions|getViewportDimensions}</li> |
| 124 | 134 | * <li>{@link Controller.getRecommendedHUDRect|getRecommendedHUDRect}</li> |
| 125 | 135 | * </ul> |
| 126 | 136 | * |
| 127 | − * <p>Virtual Game Pad</p> | |
| 137 | + * <h4>Virtual Game Pad</h4> | |
| 138 | + * <p>Use the virtual game pad which is available on some devices.</p> | |
| 128 | 139 | * <ul> |
| 129 | 140 | * <li>{@link Controller.setVPadEnabled|setVPadEnabled}</li> |
| 130 | 141 | * <li>{@link Controller.setVPadHidden|setVPadHidden}</li> |
| 131 | 142 | * <li>{@link Controller.setVPadExtraBottomMargin|setVPadExtraBottomMargin}</li> |
| 132 | 143 | * </ul> |
| 133 | 144 | * |
| 134 | − * <p>Input Recordings</p> | |
| 145 | + * <h4>Input Recordings</h4> | |
| 146 | + * <p>Create and play input recordings.</p> | |
| 135 | 147 | * <ul> |
| 136 | 148 | * <li>{@link Controller.startInputRecording|startInputRecording}</li> |
| 137 | 149 | * <li>{@link Controller.stopInputRecording|stopInputRecording}</li> |
| @@ -142,7 +154,7 @@ class ScriptEngine; · 4 unmodified lines | ||
| 142 | 154 | * <li>{@link Controller.stopInputPlayback|stopInputPlayback}</li> |
| 143 | 155 | * </ul> |
| 144 | 156 | * |
| 145 | − * <h4>Entity Methods</h4> | |
| 157 | + * <h3>Entity Methods</h3> | |
| 146 | 158 | * |
| 147 | 159 | * <p>The default scripts implement hand controller actions that use {@link Entities.callEntityMethod} to call entity script |
| 148 | 160 | * methods, if present, in the entity being interacted with.</p> |