Skip to content

Commit 916d7d0

Browse files
committed
Update api docs
1 parent 87ebc06 commit 916d7d0

1,353 files changed

Lines changed: 115052 additions & 4494 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

content/api-docs/clay-native/EReg.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,23 @@ If `n` equals 0, the whole matched substring is returned.
8585

8686
<hr class="field-separator" />
8787

88+
<div class="signature field-method has-description" id="matchedPos"><code><span class="field-name">matchedPos</span><span class="parenthesis">(</span><span class="parenthesis">)</span><span class="operator">:</span> <span class="type-name">AnonStruct</span></code><a class="header-anchor" href="#matchedPos"><span aria-hidden="true" class="header-anchor__symbol">#</span></a></div>
89+
90+
Returns the position and length of the last matched substring, within
91+
the String which was last used as argument to `this.match` or
92+
`this.matchSub`.
93+
94+
If the most recent call to `this.match` or `this.matchSub` did not
95+
match anything, the result is unspecified.
96+
97+
If the global g modifier was in place for the matching, the position and
98+
length of the leftmost substring is returned.
99+
| Returns |
100+
|---------|
101+
| AnonStruct |
102+
103+
<hr class="field-separator" />
104+
88105
<div class="signature field-method has-description" id="matchSub"><code><span class="field-name">matchSub</span><span class="parenthesis">(</span><span class="arg-name">s</span><span class="operator">:</span> <a href="/api-docs/clay-native/String/" class="type-link">String</a><span class="operator">,</span> <span class="arg-name">pos</span><span class="operator">:</span> <a href="/api-docs/clay-native/Int/" class="type-link">Int</a><span class="operator">,</span> <span class="operator">?</span><span class="arg-name">len</span><span class="operator">:</span> <a href="/api-docs/clay-native/Int/" class="type-link">Int</a> <span class="operator">=</span> <span class="default-value">-1</span><span class="parenthesis">)</span><span class="operator">:</span> <a href="/api-docs/clay-native/Bool/" class="type-link">Bool</a></code><a class="header-anchor" href="#matchSub"><span aria-hidden="true" class="header-anchor__symbol">#</span></a></div>
89106

90107
Tells if `this` regular expression matches a substring of String `s`.

content/api-docs/clay-native/StringTools.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,23 @@ If `quotes` is true, the following characters are also replaced:
7575

7676
<hr class="field-separator" />
7777

78+
<div class="signature field-method has-description" id="contains"><code><span class="field-name">contains</span><span class="parenthesis">(</span><span class="arg-name">s</span><span class="operator">:</span> <a href="/api-docs/clay-native/String/" class="type-link">String</a><span class="operator">,</span> <span class="arg-name">value</span><span class="operator">:</span> <a href="/api-docs/clay-native/String/" class="type-link">String</a><span class="parenthesis">)</span><span class="operator">:</span> <a href="/api-docs/clay-native/Bool/" class="type-link">Bool</a></code><a class="header-anchor" href="#contains"><span aria-hidden="true" class="header-anchor__symbol">#</span></a></div>
79+
80+
Returns `true` if `s` contains `value` and `false` otherwise.
81+
82+
When `value` is `null`, the result is unspecified.
83+
84+
| Name | Type |
85+
|------|------|
86+
| `s` | [String](/api-docs/clay-native/String/) |
87+
| `value` | [String](/api-docs/clay-native/String/) |
88+
89+
| Returns |
90+
|---------|
91+
| [Bool](/api-docs/clay-native/Bool/) |
92+
93+
<hr class="field-separator" />
94+
7895
<div class="signature field-method has-description" id="startsWith"><code><span class="field-name">startsWith</span><span class="parenthesis">(</span><span class="arg-name">s</span><span class="operator">:</span> <a href="/api-docs/clay-native/String/" class="type-link">String</a><span class="operator">,</span> <span class="arg-name">start</span><span class="operator">:</span> <a href="/api-docs/clay-native/String/" class="type-link">String</a><span class="parenthesis">)</span><span class="operator">:</span> <a href="/api-docs/clay-native/Bool/" class="type-link">Bool</a></code><a class="header-anchor" href="#startsWith"><span aria-hidden="true" class="header-anchor__symbol">#</span></a></div>
7996

8097
Tells if the string `s` starts with the string `start`.

content/api-docs/clay-native/Sys.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,3 +122,13 @@ Gives the most precise timestamp value available (in seconds).
122122
|---------|
123123
| [Float](/api-docs/clay-native/Float/) |
124124

125+
<hr class="field-separator" />
126+
127+
<div class="signature field-method has-description" id="cpuTime"><code><span class="field-name">cpuTime</span><span class="parenthesis">(</span><span class="parenthesis">)</span><span class="operator">:</span> <a href="/api-docs/clay-native/Float/" class="type-link">Float</a></code><a class="header-anchor" href="#cpuTime"><span aria-hidden="true" class="header-anchor__symbol">#</span></a></div>
128+
129+
Gives the most precise timestamp value available (in seconds),
130+
but only accounts for the actual time spent running on the CPU for the current thread/process.
131+
| Returns |
132+
|---------|
133+
| [Float](/api-docs/clay-native/Float/) |
134+

content/api-docs/clay-native/backend/Backend.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,13 @@ Controls the application update rate and minimum frame time:
145145
Creates a new Clay backend instance.
146146
All backend services are automatically instantiated.
147147

148+
<hr class="field-separator" />
149+
150+
<div class="signature field-var has-description has-plugin" id="http"><div class="plugin-name">http</div><code><span class="field-name">http</span><span class="operator">:</span> <a href="/api-docs/clay-native/backend/Http/" class="type-link">Http</a></code><a class="header-anchor" href="#http"><span aria-hidden="true" class="header-anchor__symbol">#</span></a></div>
151+
152+
HTTP networking backend service.
153+
Handles HTTP requests and responses (when http plugin is enabled).
154+
148155
## Private Members
149156

150157
<div class="signature field-method has-description has-plugin" id="emitReady"><div class="plugin-name">clay</div><code><span class="field-name">emitReady</span><span class="parenthesis">(</span><span class="parenthesis">)</span><span class="operator">:</span> <a href="/api-docs/clay-native/Void/" class="type-link">Void</a></code><a class="header-anchor" href="#emitReady"><span aria-hidden="true" class="header-anchor__symbol">#</span></a></div>
@@ -184,6 +191,14 @@ Provides direct access to low-level SDL events for advanced use cases.
184191
|------|------|-------------|
185192
| `event` | [clay.sdl.SDLEvent](/api-docs/clay-native/clay/sdl/SDLEvent/) | The SDL event data |
186193

194+
<hr class="field-separator" />
195+
196+
<div class="signature field-method no-description has-plugin" id="canRender"><div class="plugin-name">clay</div><code><span class="field-name">canRender</span><span class="parenthesis">(</span><span class="parenthesis">)</span><span class="operator">:</span> <a href="/api-docs/clay-native/Bool/" class="type-link">Bool</a></code><a class="header-anchor" href="#canRender"><span aria-hidden="true" class="header-anchor__symbol">#</span></a></div>
197+
198+
| Returns |
199+
|---------|
200+
| [Bool](/api-docs/clay-native/Bool/) |
201+
187202
## Metadata
188203

189204
| Name | Parameters |

content/api-docs/clay-native/backend/ClayEvents.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -423,6 +423,18 @@ Temporarily tracks removed gamepads to prevent immediate re-detection
423423

424424
<hr class="field-separator" />
425425

426+
<div class="signature field-var has-description has-plugin" id="swapAbGamepads"><div class="plugin-name">clay</div><code><span class="field-name">swapAbGamepads</span><span class="operator">:</span> <a href="/api-docs/clay-native/ceramic/IntBoolMap/" class="type-link">ceramic.IntBoolMap</a></code><a class="header-anchor" href="#swapAbGamepads"><span aria-hidden="true" class="header-anchor__symbol">#</span></a></div>
427+
428+
Tracks which gamepads need A/B button swapping (Nintendo controllers)
429+
430+
<hr class="field-separator" />
431+
432+
<div class="signature field-var has-description has-plugin" id="swapXyGamepads"><div class="plugin-name">clay</div><code><span class="field-name">swapXyGamepads</span><span class="operator">:</span> <a href="/api-docs/clay-native/ceramic/IntBoolMap/" class="type-link">ceramic.IntBoolMap</a></code><a class="header-anchor" href="#swapXyGamepads"><span aria-hidden="true" class="header-anchor__symbol">#</span></a></div>
433+
434+
Tracks which gamepads need X/Y button swapping (Nintendo controllers)
435+
436+
<hr class="field-separator" />
437+
426438
<div class="signature field-var has-description has-plugin" id="gamepadAxisToButton"><div class="plugin-name">clay</div><code><span class="field-name">gamepadAxisToButton</span><span class="operator">:</span> <a href="/api-docs/clay-native/ceramic/IntIntMap/" class="type-link">ceramic.IntIntMap</a></code><a class="header-anchor" href="#gamepadAxisToButton"><span aria-hidden="true" class="header-anchor__symbol">#</span></a></div>
427439

428440
Maps gamepad axis IDs to virtual button IDs (for triggers)

0 commit comments

Comments
 (0)