History

Revise formatting of Facilities and Entity Methods sections

David Rowe committed 7 years ago

Commit 3032b581 parent 407ce741 file · +32 −20Browse files

Showing the changes to interface/src/scripting/ControllerScriptingInterface.h (1 of 1 file). Show all

Unified · Split

interface/src/scripting/ControllerScriptingInterface.h+32−20
@@ -28,16 +28,18 @@ class ScriptEngine; · 27 unmodified lines
2828 /**jsdoc
2929 * The <code>Controller</code> API provides facilities to interact with computer and controller hardware.
3030 *
31− * <h4>Facilities</h4>
31+ * <h3>Facilities</h3>
3232 *
33− * <p>Properties</p>
33+ * <h4>Properties</h4>
34+ * <p>Get <code>Controller</code> property trees.</p>
3435 * <ul>
3536 * <li>{@link Controller.getActions|getActions}</li>
3637 * <li>{@link Controller.getHardware|getHardware}</li>
3738 * <li>{@link Controller.getStandard|getStandard}</li>
3839 * </ul>
3940 *
40− * <p>Mappings</p>
41+ * <h4>Mappings</h4>
42+ * <p>Create and enable or disable <code>Controller</code> mappings.</p>
4143 * <ul>
4244 * <li>{@link Controller.disableMapping|disableMapping}</li>
4345 * <li>{@link Controller.enableMapping|enableMapping}</li>
@@ -46,7 +48,8 @@ class ScriptEngine; · 2 unmodified lines
4648 * <li>{@link Controller.parseMapping|parseMapping}</li>
4749 * </ul>
4850 *
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>
5053 * <ul>
5154 * <li>{@link Controller.findAction|findAction}</li>
5255 * <li>{@link Controller.findDevice|findDevice}</li>
@@ -58,7 +61,8 @@ class ScriptEngine; · 5 unmodified lines
5861 * <li>{@link Controller.getRunningInputDevices|getRunningInputDevices}</li>
5962 * </ul>
6063 *
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>
6266 * <ul>
6367 * <li>{@link Controller.actionEvent|actionEvent}</li>
6468 * <li>{@link Controller.hardwareChanged|hardwareChanged}</li>
@@ -66,7 +70,8 @@ class ScriptEngine; · 1 unmodified line
6670 * <li>{@link Controller.inputEvent|inputEvent}</li>
6771 * </ul>
6872 *
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>
7075 * <ul>
7176 * <li>{@link Controller.keyPressEvent|keyPressEvent}</li>
7277 * <li>{@link Controller.keyReleaseEvent|keyReleaseEvent}</li>
@@ -80,29 +85,32 @@ class ScriptEngine; · 7 unmodified lines
8085 * <li>{@link Controller.wheelEvent|wheelEvent}</li>
8186 * </ul>
8287 *
83− * <p>Control Capturing</p>
88+ * <h4>Control Capturing</h4>
89+ * <p>Disable and enable the processing of mouse and touch events.</p>
8490 * <ul>
8591 * <li>{@link Controller.captureMouseEvents|captureMouseEvents}</li>
86− * <li>{@link Controller.captureTouchEvents|captureTouchEvents}</li>
8792 * <li>{@link Controller.captureWheelEvents|captureWheelEvents}</li>
93+ * <li>{@link Controller.captureTouchEvents|captureTouchEvents}</li>
8894 * <li>{@link Controller.releaseMouseEvents|releaseMouseEvents}</li>
89− * <li>{@link Controller.releaseTouchEvents|releaseTouchEvents}</li>
9095 * <li>{@link Controller.releaseWheelEvents|releaseWheelEvents}</li>
96+ * <li>{@link Controller.releaseTouchEvents|releaseTouchEvents}</li>
9197 * </ul>
9298 *
93− * <p>Action Capturing</p>
99+ * <h4>Action Capturing</h4>
100+ * <p>Disable and enable controller actions.</p>
94101 * <ul>
95102 * <li>{@link Controller.captureActionEvents|captureActionEvents}</li>
96− * <li>{@link Controller.captureEntityClickEvents|captureEntityClickEvents}</li>
97− * <li>{@link Controller.captureJoystick|captureJoystick}</li>
98103 * <li>{@link Controller.captureKeyEvents|captureKeyEvents}</li>
104+ * <li>{@link Controller.captureJoystick|captureJoystick}</li>
105+ * <li>{@link Controller.captureEntityClickEvents|captureEntityClickEvents}</li>
99106 * <li>{@link Controller.releaseActionEvents|releaseActionEvents}</li>
100− * <li>{@link Controller.releaseEntityClickEvents|releaseEntityClickEvents}</li>
101− * <li>{@link Controller.releaseJoystick|releaseJoystick}</li>
102107 * <li>{@link Controller.releaseKeyEvents|releaseKeyEvents}</li>
108+ * <li>{@link Controller.releaseJoystick|releaseJoystick}</li>
109+ * <li>{@link Controller.releaseEntityClickEvents|releaseEntityClickEvents}</li>
103110 * </ul>
104111 *
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>
106114 * <ul>
107115 * <li>{@link Controller.getValue|getValue}</li>
108116 * <li>{@link Controller.getAxisValue|getAxisValue}</li>
@@ -110,7 +118,8 @@ class ScriptEngine; · 1 unmodified line
110118 * <li>{@link Controller.getActionValue|getActionValue}</li>
111119 * </ul>
112120 *
113− * <p>Haptics</p>
121+ * <h4>Haptics</h4>
122+ * <p>Trigger haptic pulses.</p>
114123 * <ul>
115124 * <li>{@link Controller.triggerHapticPulse|triggerHapticPulse}</li>
116125 * <li>{@link Controller.triggerHapticPulseOnDevice|triggerHapticPulseOnDevice}</li>
@@ -118,20 +127,23 @@ class ScriptEngine; · 1 unmodified line
118127 * <li>{@link Controller.triggerShortHapticPulseOnDevice|triggerShortHapticPulseOnDevice}</li>
119128 * </ul>
120129 *
121− * <p>Display Information</p>
130+ * <h4>Display Information</h4>
131+ * <p>Get information on the display.</p>
122132 * <ul>
123133 * <li>{@link Controller.getViewportDimensions|getViewportDimensions}</li>
124134 * <li>{@link Controller.getRecommendedHUDRect|getRecommendedHUDRect}</li>
125135 * </ul>
126136 *
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>
128139 * <ul>
129140 * <li>{@link Controller.setVPadEnabled|setVPadEnabled}</li>
130141 * <li>{@link Controller.setVPadHidden|setVPadHidden}</li>
131142 * <li>{@link Controller.setVPadExtraBottomMargin|setVPadExtraBottomMargin}</li>
132143 * </ul>
133144 *
134− * <p>Input Recordings</p>
145+ * <h4>Input Recordings</h4>
146+ * <p>Create and play input recordings.</p>
135147 * <ul>
136148 * <li>{@link Controller.startInputRecording|startInputRecording}</li>
137149 * <li>{@link Controller.stopInputRecording|stopInputRecording}</li>
@@ -142,7 +154,7 @@ class ScriptEngine; · 4 unmodified lines
142154 * <li>{@link Controller.stopInputPlayback|stopInputPlayback}</li>
143155 * </ul>
144156 *
145− * <h4>Entity Methods</h4>
157+ * <h3>Entity Methods</h3>
146158 *
147159 * <p>The default scripts implement hand controller actions that use {@link Entities.callEntityMethod} to call entity script
148160 * methods, if present, in the entity being interacted with.</p>

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t