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
28/**jsdoc28/**jsdoc
29 * The <code>Controller</code> API provides facilities to interact with computer and controller hardware.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 * <ul>35 * <ul>
35 * <li>{@link Controller.getActions|getActions}</li>36 * <li>{@link Controller.getActions|getActions}</li>
36 * <li>{@link Controller.getHardware|getHardware}</li>37 * <li>{@link Controller.getHardware|getHardware}</li>
37 * <li>{@link Controller.getStandard|getStandard}</li>38 * <li>{@link Controller.getStandard|getStandard}</li>
38 * </ul>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 * <ul>43 * <ul>
42 * <li>{@link Controller.disableMapping|disableMapping}</li>44 * <li>{@link Controller.disableMapping|disableMapping}</li>
43 * <li>{@link Controller.enableMapping|enableMapping}</li>45 * <li>{@link Controller.enableMapping|enableMapping}</li>
@@ -46,7 +48,8 @@ class ScriptEngine; · 2 unmodified lines
46 * <li>{@link Controller.parseMapping|parseMapping}</li>48 * <li>{@link Controller.parseMapping|parseMapping}</li>
47 * </ul>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 * <ul>53 * <ul>
51 * <li>{@link Controller.findAction|findAction}</li>54 * <li>{@link Controller.findAction|findAction}</li>
52 * <li>{@link Controller.findDevice|findDevice}</li>55 * <li>{@link Controller.findDevice|findDevice}</li>
@@ -58,7 +61,8 @@ class ScriptEngine; · 5 unmodified lines
58 * <li>{@link Controller.getRunningInputDevices|getRunningInputDevices}</li>61 * <li>{@link Controller.getRunningInputDevices|getRunningInputDevices}</li>
59 * </ul>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 * <ul>66 * <ul>
63 * <li>{@link Controller.actionEvent|actionEvent}</li>67 * <li>{@link Controller.actionEvent|actionEvent}</li>
64 * <li>{@link Controller.hardwareChanged|hardwareChanged}</li>68 * <li>{@link Controller.hardwareChanged|hardwareChanged}</li>
@@ -66,7 +70,8 @@ class ScriptEngine; · 1 unmodified line
66 * <li>{@link Controller.inputEvent|inputEvent}</li>70 * <li>{@link Controller.inputEvent|inputEvent}</li>
67 * </ul>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 * <ul>75 * <ul>
71 * <li>{@link Controller.keyPressEvent|keyPressEvent}</li>76 * <li>{@link Controller.keyPressEvent|keyPressEvent}</li>
72 * <li>{@link Controller.keyReleaseEvent|keyReleaseEvent}</li>77 * <li>{@link Controller.keyReleaseEvent|keyReleaseEvent}</li>
@@ -80,29 +85,32 @@ class ScriptEngine; · 7 unmodified lines
80 * <li>{@link Controller.wheelEvent|wheelEvent}</li>85 * <li>{@link Controller.wheelEvent|wheelEvent}</li>
81 * </ul>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 * <ul>90 * <ul>
85 * <li>{@link Controller.captureMouseEvents|captureMouseEvents}</li>91 * <li>{@link Controller.captureMouseEvents|captureMouseEvents}</li>
86 * <li>{@link Controller.captureTouchEvents|captureTouchEvents}</li>
87 * <li>{@link Controller.captureWheelEvents|captureWheelEvents}</li>92 * <li>{@link Controller.captureWheelEvents|captureWheelEvents}</li>
93 * <li>{@link Controller.captureTouchEvents|captureTouchEvents}</li>
88 * <li>{@link Controller.releaseMouseEvents|releaseMouseEvents}</li>94 * <li>{@link Controller.releaseMouseEvents|releaseMouseEvents}</li>
89 * <li>{@link Controller.releaseTouchEvents|releaseTouchEvents}</li>
90 * <li>{@link Controller.releaseWheelEvents|releaseWheelEvents}</li>95 * <li>{@link Controller.releaseWheelEvents|releaseWheelEvents}</li>
96 * <li>{@link Controller.releaseTouchEvents|releaseTouchEvents}</li>
91 * </ul>97 * </ul>
92 *98 *
93 * <p>Action Capturing</p>99 * <h4>Action Capturing</h4>
100 * <p>Disable and enable controller actions.</p>
94 * <ul>101 * <ul>
95 * <li>{@link Controller.captureActionEvents|captureActionEvents}</li>102 * <li>{@link Controller.captureActionEvents|captureActionEvents}</li>
96 * <li>{@link Controller.captureEntityClickEvents|captureEntityClickEvents}</li>
97 * <li>{@link Controller.captureJoystick|captureJoystick}</li>
98 * <li>{@link Controller.captureKeyEvents|captureKeyEvents}</li>103 * <li>{@link Controller.captureKeyEvents|captureKeyEvents}</li>
104 * <li>{@link Controller.captureJoystick|captureJoystick}</li>
105 * <li>{@link Controller.captureEntityClickEvents|captureEntityClickEvents}</li>
99 * <li>{@link Controller.releaseActionEvents|releaseActionEvents}</li>106 * <li>{@link Controller.releaseActionEvents|releaseActionEvents}</li>
100 * <li>{@link Controller.releaseEntityClickEvents|releaseEntityClickEvents}</li>
101 * <li>{@link Controller.releaseJoystick|releaseJoystick}</li>
102 * <li>{@link Controller.releaseKeyEvents|releaseKeyEvents}</li>107 * <li>{@link Controller.releaseKeyEvents|releaseKeyEvents}</li>
108 * <li>{@link Controller.releaseJoystick|releaseJoystick}</li>
109 * <li>{@link Controller.releaseEntityClickEvents|releaseEntityClickEvents}</li>
103 * </ul>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 * <ul>114 * <ul>
107 * <li>{@link Controller.getValue|getValue}</li>115 * <li>{@link Controller.getValue|getValue}</li>
108 * <li>{@link Controller.getAxisValue|getAxisValue}</li>116 * <li>{@link Controller.getAxisValue|getAxisValue}</li>
@@ -110,7 +118,8 @@ class ScriptEngine; · 1 unmodified line
110 * <li>{@link Controller.getActionValue|getActionValue}</li>118 * <li>{@link Controller.getActionValue|getActionValue}</li>
111 * </ul>119 * </ul>
112 *120 *
113 * <p>Haptics</p>121 * <h4>Haptics</h4>
122 * <p>Trigger haptic pulses.</p>
114 * <ul>123 * <ul>
115 * <li>{@link Controller.triggerHapticPulse|triggerHapticPulse}</li>124 * <li>{@link Controller.triggerHapticPulse|triggerHapticPulse}</li>
116 * <li>{@link Controller.triggerHapticPulseOnDevice|triggerHapticPulseOnDevice}</li>125 * <li>{@link Controller.triggerHapticPulseOnDevice|triggerHapticPulseOnDevice}</li>
@@ -118,20 +127,23 @@ class ScriptEngine; · 1 unmodified line
118 * <li>{@link Controller.triggerShortHapticPulseOnDevice|triggerShortHapticPulseOnDevice}</li>127 * <li>{@link Controller.triggerShortHapticPulseOnDevice|triggerShortHapticPulseOnDevice}</li>
119 * </ul>128 * </ul>
120 *129 *
121 * <p>Display Information</p>130 * <h4>Display Information</h4>
131 * <p>Get information on the display.</p>
122 * <ul>132 * <ul>
123 * <li>{@link Controller.getViewportDimensions|getViewportDimensions}</li>133 * <li>{@link Controller.getViewportDimensions|getViewportDimensions}</li>
124 * <li>{@link Controller.getRecommendedHUDRect|getRecommendedHUDRect}</li>134 * <li>{@link Controller.getRecommendedHUDRect|getRecommendedHUDRect}</li>
125 * </ul>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 * <ul>139 * <ul>
129 * <li>{@link Controller.setVPadEnabled|setVPadEnabled}</li>140 * <li>{@link Controller.setVPadEnabled|setVPadEnabled}</li>
130 * <li>{@link Controller.setVPadHidden|setVPadHidden}</li>141 * <li>{@link Controller.setVPadHidden|setVPadHidden}</li>
131 * <li>{@link Controller.setVPadExtraBottomMargin|setVPadExtraBottomMargin}</li>142 * <li>{@link Controller.setVPadExtraBottomMargin|setVPadExtraBottomMargin}</li>
132 * </ul>143 * </ul>
133 *144 *
134 * <p>Input Recordings</p>145 * <h4>Input Recordings</h4>
146 * <p>Create and play input recordings.</p>
135 * <ul>147 * <ul>
136 * <li>{@link Controller.startInputRecording|startInputRecording}</li>148 * <li>{@link Controller.startInputRecording|startInputRecording}</li>
137 * <li>{@link Controller.stopInputRecording|stopInputRecording}</li>149 * <li>{@link Controller.stopInputRecording|stopInputRecording}</li>
@@ -142,7 +154,7 @@ class ScriptEngine; · 4 unmodified lines
142 * <li>{@link Controller.stopInputPlayback|stopInputPlayback}</li>154 * <li>{@link Controller.stopInputPlayback|stopInputPlayback}</li>
143 * </ul>155 * </ul>
144 *156 *
145 * <h4>Entity Methods</h4>157 * <h3>Entity Methods</h3>
146 *158 *
147 * <p>The default scripts implement hand controller actions that use {@link Entities.callEntityMethod} to call entity script 159 * <p>The default scripts implement hand controller actions that use {@link Entities.callEntityMethod} to call entity script
148 * methods, if present, in the entity being interacted with.</p>160 * 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