@origingame/engine 0.1.1 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (59) hide show
  1. package/dist/web/origin-engine.js +4 -4
  2. package/dist/web/origin-engine_bg.wasm +0 -0
  3. package/dist/web-publish/origin-engine-lanes.js +6 -6
  4. package/dist/web-publish/origin-engine-lanes_bg.wasm +0 -0
  5. package/dist/web-publish/origin-engine.js +4 -4
  6. package/dist/web-publish/origin-engine_bg.wasm +0 -0
  7. package/dist/web-publish-2d/origin-engine-lanes.js +6 -6
  8. package/dist/web-publish-2d/origin-engine-lanes_bg.wasm +0 -0
  9. package/dist/web-publish-2d/origin-engine.js +4 -4
  10. package/dist/web-publish-2d/origin-engine_bg.wasm +0 -0
  11. package/knowledge/package.json +4 -4
  12. package/knowledge/scaffold/origin-engine.json +2 -2
  13. package/knowledge/scaffold/template/package.json +1 -1
  14. package/knowledge/scaffold/template/project.ogt +1 -1
  15. package/knowledge/scripts/validate.ts +2 -1
  16. package/knowledge/skills/og-build/SKILL.md +17 -1
  17. package/knowledge/skills/og-feel/SKILL.md +8 -1
  18. package/knowledge/skills/og-game/SKILL.md +117 -13
  19. package/knowledge/skills/og-i18n/SKILL.md +12 -3
  20. package/knowledge/skills/og-platform-sdk/SKILL.md +3 -1
  21. package/knowledge/skills/og-ui/SKILL.md +19 -6
  22. package/knowledge/wiki/ai.md +20 -20
  23. package/knowledge/wiki/anim.md +41 -41
  24. package/knowledge/wiki/atmosphere.md +13 -13
  25. package/knowledge/wiki/audio.md +18 -18
  26. package/knowledge/wiki/camera.md +13 -13
  27. package/knowledge/wiki/commands.md +11 -11
  28. package/knowledge/wiki/game.md +8 -8
  29. package/knowledge/wiki/i18n.md +7 -7
  30. package/knowledge/wiki/index.md +4 -1
  31. package/knowledge/wiki/input.md +47 -47
  32. package/knowledge/wiki/load.md +45 -45
  33. package/knowledge/wiki/math.md +7 -7
  34. package/knowledge/wiki/nav.md +34 -34
  35. package/knowledge/wiki/physics.md +124 -106
  36. package/knowledge/wiki/platform.md +31 -31
  37. package/knowledge/wiki/probe.md +66 -66
  38. package/knowledge/wiki/reflect.md +15 -15
  39. package/knowledge/wiki/render.md +99 -89
  40. package/knowledge/wiki/rng.md +14 -14
  41. package/knowledge/wiki/stream.md +15 -15
  42. package/knowledge/wiki/system.md +8 -8
  43. package/knowledge/wiki/systems.md +2 -2
  44. package/knowledge/wiki/terrain.md +19 -19
  45. package/knowledge/wiki/tilemap.md +19 -15
  46. package/knowledge/wiki/time.md +4 -4
  47. package/knowledge/wiki/transform.md +8 -8
  48. package/knowledge/wiki/tween.md +17 -17
  49. package/knowledge/wiki/ui.md +289 -245
  50. package/knowledge/wiki/world.md +67 -37
  51. package/package.json +6 -6
  52. package/schema/api.schema.json +134 -9
  53. package/src/index.ts +1 -0
  54. package/src/node/polish.ts +2 -1
  55. package/src/node/run.ts +5 -1
  56. package/src/runtime.ts +2 -0
  57. package/src/ui-kit/huds.ts +18 -14
  58. package/types/bindings.json +61 -26
  59. package/types/index.d.ts +144 -13
@@ -18,7 +18,7 @@ module audio {
18
18
  # declarations follow, each quoted below
19
19
  ```
20
20
 
21
- <sub>`api.ogt` line 6408</sub>
21
+ <sub>`api.ogt` line 6440</sub>
22
22
 
23
23
  ## Contents
24
24
 
@@ -73,7 +73,7 @@ fn outputLatency {
73
73
  }
74
74
  ```
75
75
 
76
- <sub>`api.ogt` line 6788</sub>
76
+ <sub>`api.ogt` line 6820</sub>
77
77
 
78
78
  ## Components, resources and events
79
79
 
@@ -200,7 +200,7 @@ component AudioSource {
200
200
  }
201
201
  ```
202
202
 
203
- <sub>`api.ogt` line 6435</sub>
203
+ <sub>`api.ogt` line 6467</sub>
204
204
 
205
205
  <a id="record-AudioListener"></a>
206
206
 
@@ -226,7 +226,7 @@ component AudioListener {
226
226
  }
227
227
  ```
228
228
 
229
- <sub>`api.ogt` line 6523</sub>
229
+ <sub>`api.ogt` line 6555</sub>
230
230
 
231
231
  <a id="record-Audio"></a>
232
232
 
@@ -314,7 +314,7 @@ resource Audio {
314
314
  }
315
315
  ```
316
316
 
317
- <sub>`api.ogt` line 6533</sub>
317
+ <sub>`api.ogt` line 6565</sub>
318
318
 
319
319
  <a id="record-AudioBusFx"></a>
320
320
 
@@ -435,7 +435,7 @@ component AudioBusFx {
435
435
  }
436
436
  ```
437
437
 
438
- <sub>`api.ogt` line 6596</sub>
438
+ <sub>`api.ogt` line 6628</sub>
439
439
 
440
440
  <a id="record-ReverbZone"></a>
441
441
 
@@ -506,7 +506,7 @@ component ReverbZone {
506
506
  }
507
507
  ```
508
508
 
509
- <sub>`api.ogt` line 6685</sub>
509
+ <sub>`api.ogt` line 6717</sub>
510
510
 
511
511
  <a id="record-Music"></a>
512
512
 
@@ -562,7 +562,7 @@ component Music {
562
562
  }
563
563
  ```
564
564
 
565
- <sub>`api.ogt` line 6731</sub>
565
+ <sub>`api.ogt` line 6763</sub>
566
566
 
567
567
  <a id="record-MusicBeat"></a>
568
568
 
@@ -589,7 +589,7 @@ event MusicBeat {
589
589
  }
590
590
  ```
591
591
 
592
- <sub>`api.ogt` line 6765</sub>
592
+ <sub>`api.ogt` line 6797</sub>
593
593
 
594
594
  <a id="record-SoundStarted"></a>
595
595
 
@@ -614,7 +614,7 @@ event SoundStarted {
614
614
  }
615
615
  ```
616
616
 
617
- <sub>`api.ogt` line 6773</sub>
617
+ <sub>`api.ogt` line 6805</sub>
618
618
 
619
619
  <a id="record-SoundEnded"></a>
620
620
 
@@ -641,7 +641,7 @@ event SoundEnded {
641
641
  }
642
642
  ```
643
643
 
644
- <sub>`api.ogt` line 6780</sub>
644
+ <sub>`api.ogt` line 6812</sub>
645
645
 
646
646
  ## Types
647
647
 
@@ -670,7 +670,7 @@ enum AudioBus {
670
670
  }
671
671
  ```
672
672
 
673
- <sub>`api.ogt` line 6420</sub>
673
+ <sub>`api.ogt` line 6452</sub>
674
674
 
675
675
  ## Column kinds
676
676
 
@@ -689,7 +689,7 @@ column AudioBus {
689
689
  }
690
690
  ```
691
691
 
692
- <sub>`api.ogt` line 6428</sub>
692
+ <sub>`api.ogt` line 6460</sub>
693
693
 
694
694
  ## Constants
695
695
 
@@ -705,28 +705,28 @@ column AudioBus {
705
705
  const SOUND_FINISHED u32 0 "SoundEnded.reason: a one-shot played to its end."
706
706
  ```
707
707
 
708
- <sub>`api.ogt` line 6414</sub>
708
+ <sub>`api.ogt` line 6446</sub>
709
709
 
710
710
  ```ogt
711
711
  const SOUND_STOPPED u32 1 "SoundEnded.reason: `playing` was set to false."
712
712
  ```
713
713
 
714
- <sub>`api.ogt` line 6415</sub>
714
+ <sub>`api.ogt` line 6447</sub>
715
715
 
716
716
  ```ogt
717
717
  const SOUND_REMOVED u32 2 "SoundEnded.reason: the AudioSource was removed from a living entity."
718
718
  ```
719
719
 
720
- <sub>`api.ogt` line 6416</sub>
720
+ <sub>`api.ogt` line 6448</sub>
721
721
 
722
722
  ```ogt
723
723
  const SOUND_REPLACED u32 3 "SoundEnded.reason: `sound` changed while it played."
724
724
  ```
725
725
 
726
- <sub>`api.ogt` line 6417</sub>
726
+ <sub>`api.ogt` line 6449</sub>
727
727
 
728
728
  ```ogt
729
729
  const SOUND_CULLED u32 4 "SoundEnded.reason: more sources played than Audio.maxVoices and this one stood lowest (priority, then volume, then age)."
730
730
  ```
731
731
 
732
- <sub>`api.ogt` line 6418</sub>
732
+ <sub>`api.ogt` line 6450</sub>
@@ -16,7 +16,7 @@ module camera {
16
16
  # declarations follow, each quoted below
17
17
  ```
18
18
 
19
- <sub>`api.ogt` line 1288</sub>
19
+ <sub>`api.ogt` line 1299</sub>
20
20
 
21
21
  ## Contents
22
22
 
@@ -62,7 +62,7 @@ fn shake {
62
62
  }
63
63
  ```
64
64
 
65
- <sub>`api.ogt` line 1624</sub>
65
+ <sub>`api.ogt` line 1635</sub>
66
66
 
67
67
  <a id="fn-punch"></a>
68
68
 
@@ -92,7 +92,7 @@ fn punch {
92
92
  }
93
93
  ```
94
94
 
95
- <sub>`api.ogt` line 1631</sub>
95
+ <sub>`api.ogt` line 1642</sub>
96
96
 
97
97
  <a id="fn-kick"></a>
98
98
 
@@ -124,7 +124,7 @@ fn kick {
124
124
  }
125
125
  ```
126
126
 
127
- <sub>`api.ogt` line 1638</sub>
127
+ <sub>`api.ogt` line 1649</sub>
128
128
 
129
129
  ## Components, resources and events
130
130
 
@@ -298,7 +298,7 @@ resource Camera {
298
298
  }
299
299
  ```
300
300
 
301
- <sub>`api.ogt` line 1293</sub>
301
+ <sub>`api.ogt` line 1304</sub>
302
302
 
303
303
  <a id="member-Camera-lookAt"></a>
304
304
 
@@ -325,7 +325,7 @@ fn lookAt {
325
325
  }
326
326
  ```
327
327
 
328
- <sub>`api.ogt` line 1406</sub>
328
+ <sub>`api.ogt` line 1417</sub>
329
329
 
330
330
  <a id="member-Camera-worldToScreen"></a>
331
331
 
@@ -353,7 +353,7 @@ fn worldToScreen {
353
353
  }
354
354
  ```
355
355
 
356
- <sub>`api.ogt` line 1410</sub>
356
+ <sub>`api.ogt` line 1421</sub>
357
357
 
358
358
  <a id="member-Camera-screenToRay"></a>
359
359
 
@@ -383,7 +383,7 @@ fn screenToRay {
383
383
  }
384
384
  ```
385
385
 
386
- <sub>`api.ogt` line 1415</sub>
386
+ <sub>`api.ogt` line 1426</sub>
387
387
 
388
388
  <a id="record-OrbitCamera"></a>
389
389
 
@@ -491,7 +491,7 @@ component OrbitCamera {
491
491
  }
492
492
  ```
493
493
 
494
- <sub>`api.ogt` line 1423</sub>
494
+ <sub>`api.ogt` line 1434</sub>
495
495
 
496
496
  <a id="record-FollowCamera"></a>
497
497
 
@@ -529,7 +529,7 @@ component FollowCamera {
529
529
  }
530
530
  ```
531
531
 
532
- <sub>`api.ogt` line 1497</sub>
532
+ <sub>`api.ogt` line 1508</sub>
533
533
 
534
534
  <a id="record-Follow2D"></a>
535
535
 
@@ -608,7 +608,7 @@ component Follow2D {
608
608
  }
609
609
  ```
610
610
 
611
- <sub>`api.ogt` line 1516</sub>
611
+ <sub>`api.ogt` line 1527</sub>
612
612
 
613
613
  <a id="record-CameraZone"></a>
614
614
 
@@ -643,7 +643,7 @@ component CameraZone {
643
643
  }
644
644
  ```
645
645
 
646
- <sub>`api.ogt` line 1568</sub>
646
+ <sub>`api.ogt` line 1579</sub>
647
647
 
648
648
  <a id="record-CameraRail"></a>
649
649
 
@@ -708,4 +708,4 @@ component CameraRail {
708
708
  }
709
709
  ```
710
710
 
711
- <sub>`api.ogt` line 1584</sub>
711
+ <sub>`api.ogt` line 1595</sub>
@@ -18,7 +18,7 @@ module commands {
18
18
  # declarations follow, each quoted below
19
19
  ```
20
20
 
21
- <sub>`api.ogt` line 10355</sub>
21
+ <sub>`api.ogt` line 10420</sub>
22
22
 
23
23
  ## Contents
24
24
 
@@ -67,7 +67,7 @@ fn register {
67
67
  }
68
68
  ```
69
69
 
70
- <sub>`api.ogt` line 10431</sub>
70
+ <sub>`api.ogt` line 10496</sub>
71
71
 
72
72
  <a id="fn-parse"></a>
73
73
 
@@ -95,7 +95,7 @@ fn parse {
95
95
  }
96
96
  ```
97
97
 
98
- <sub>`api.ogt` line 10439</sub>
98
+ <sub>`api.ogt` line 10504</sub>
99
99
 
100
100
  <a id="fn-help"></a>
101
101
 
@@ -123,7 +123,7 @@ fn help {
123
123
  }
124
124
  ```
125
125
 
126
- <sub>`api.ogt` line 10445</sub>
126
+ <sub>`api.ogt` line 10510</sub>
127
127
 
128
128
  <a id="fn-schedule"></a>
129
129
 
@@ -153,7 +153,7 @@ fn schedule {
153
153
  }
154
154
  ```
155
155
 
156
- <sub>`api.ogt` line 10451</sub>
156
+ <sub>`api.ogt` line 10516</sub>
157
157
 
158
158
  ## Types
159
159
 
@@ -230,7 +230,7 @@ enum CoreAction {
230
230
  }
231
231
  ```
232
232
 
233
- <sub>`api.ogt` line 10362</sub>
233
+ <sub>`api.ogt` line 10427</sub>
234
234
 
235
235
  <a id="type-CommandHandler"></a>
236
236
 
@@ -257,7 +257,7 @@ callback CommandHandler {
257
257
  }
258
258
  ```
259
259
 
260
- <sub>`api.ogt` line 10394</sub>
260
+ <sub>`api.ogt` line 10459</sub>
261
261
 
262
262
  <a id="type-CommandDesc"></a>
263
263
 
@@ -281,7 +281,7 @@ struct CommandDesc {
281
281
  }
282
282
  ```
283
283
 
284
- <sub>`api.ogt` line 10400</sub>
284
+ <sub>`api.ogt` line 10465</sub>
285
285
 
286
286
  <a id="type-CommandStep"></a>
287
287
 
@@ -306,7 +306,7 @@ struct CommandStep {
306
306
  }
307
307
  ```
308
308
 
309
- <sub>`api.ogt` line 10407</sub>
309
+ <sub>`api.ogt` line 10472</sub>
310
310
 
311
311
  <a id="type-CommandInfo"></a>
312
312
 
@@ -331,7 +331,7 @@ struct CommandInfo {
331
331
  }
332
332
  ```
333
333
 
334
- <sub>`api.ogt` line 10416</sub>
334
+ <sub>`api.ogt` line 10481</sub>
335
335
 
336
336
  <a id="type-CommandsReport"></a>
337
337
 
@@ -354,4 +354,4 @@ struct CommandsReport {
354
354
  }
355
355
  ```
356
356
 
357
- <sub>`api.ogt` line 10424</sub>
357
+ <sub>`api.ogt` line 10489</sub>
@@ -14,7 +14,7 @@ module game {
14
14
  # declarations follow, each quoted below
15
15
  ```
16
16
 
17
- <sub>`api.ogt` line 460</sub>
17
+ <sub>`api.ogt` line 471</sub>
18
18
 
19
19
  ## Contents
20
20
 
@@ -54,7 +54,7 @@ fn game {
54
54
  }
55
55
  ```
56
56
 
57
- <sub>`api.ogt` line 512</sub>
57
+ <sub>`api.ogt` line 523</sub>
58
58
 
59
59
  ## Interfaces
60
60
 
@@ -70,7 +70,7 @@ interface Game {
70
70
  # members follow, each quoted below
71
71
  ```
72
72
 
73
- <sub>`api.ogt` line 506</sub>
73
+ <sub>`api.ogt` line 517</sub>
74
74
 
75
75
  <a id="member-Game-tick"></a>
76
76
 
@@ -88,7 +88,7 @@ Binding symbol `og_game_get_tick` · publish builds: kept
88
88
  prop tick u32 "GameDesc.tick, or 60 when it is unset (the engine then runs at project.ogt's `tick` when the host passes the project, as og run and og build do)."
89
89
  ```
90
90
 
91
- <sub>`api.ogt` line 508</sub>
91
+ <sub>`api.ogt` line 519</sub>
92
92
 
93
93
  <a id="member-Game-systems"></a>
94
94
 
@@ -106,7 +106,7 @@ Binding symbol `og_game_get_systems` · publish builds: kept
106
106
  prop systems List.System "The systems in declaration order."
107
107
  ```
108
108
 
109
- <sub>`api.ogt` line 509</sub>
109
+ <sub>`api.ogt` line 520</sub>
110
110
 
111
111
  ## Types
112
112
 
@@ -134,7 +134,7 @@ callback FactsFn {
134
134
  }
135
135
  ```
136
136
 
137
- <sub>`api.ogt` line 465</sub>
137
+ <sub>`api.ogt` line 476</sub>
138
138
 
139
139
  <a id="type-StartFn"></a>
140
140
 
@@ -159,7 +159,7 @@ callback StartFn {
159
159
  }
160
160
  ```
161
161
 
162
- <sub>`api.ogt` line 471</sub>
162
+ <sub>`api.ogt` line 482</sub>
163
163
 
164
164
  <a id="type-GameDesc"></a>
165
165
 
@@ -217,4 +217,4 @@ struct GameDesc {
217
217
  }
218
218
  ```
219
219
 
220
- <sub>`api.ogt` line 476</sub>
220
+ <sub>`api.ogt` line 487</sub>
@@ -16,7 +16,7 @@ module i18n {
16
16
  # declarations follow, each quoted below
17
17
  ```
18
18
 
19
- <sub>`api.ogt` line 7718</sub>
19
+ <sub>`api.ogt` line 7750</sub>
20
20
 
21
21
  ## Contents
22
22
 
@@ -59,7 +59,7 @@ fn load {
59
59
  }
60
60
  ```
61
61
 
62
- <sub>`api.ogt` line 7732</sub>
62
+ <sub>`api.ogt` line 7764</sub>
63
63
 
64
64
  <a id="fn-setLocale"></a>
65
65
 
@@ -89,7 +89,7 @@ fn setLocale {
89
89
  }
90
90
  ```
91
91
 
92
- <sub>`api.ogt` line 7739</sub>
92
+ <sub>`api.ogt` line 7771</sub>
93
93
 
94
94
  <a id="fn-locale"></a>
95
95
 
@@ -117,7 +117,7 @@ fn locale {
117
117
  }
118
118
  ```
119
119
 
120
- <sub>`api.ogt` line 7746</sub>
120
+ <sub>`api.ogt` line 7778</sub>
121
121
 
122
122
  <a id="fn-t"></a>
123
123
 
@@ -151,7 +151,7 @@ fn t {
151
151
  }
152
152
  ```
153
153
 
154
- <sub>`api.ogt` line 7752</sub>
154
+ <sub>`api.ogt` line 7784</sub>
155
155
 
156
156
  <a id="fn-has"></a>
157
157
 
@@ -181,7 +181,7 @@ fn has {
181
181
  }
182
182
  ```
183
183
 
184
- <sub>`api.ogt` line 7762</sub>
184
+ <sub>`api.ogt` line 7794</sub>
185
185
 
186
186
  ## Types
187
187
 
@@ -210,4 +210,4 @@ struct LocaleInfo {
210
210
  }
211
211
  ```
212
212
 
213
- <sub>`api.ogt` line 7723</sub>
213
+ <sub>`api.ogt` line 7755</sub>
@@ -102,6 +102,7 @@ Field units the docs and Tune use.
102
102
  | `ratio` | a fraction between 0 and 1 |
103
103
  | `bytes` | bytes |
104
104
  | `kg` | kilograms |
105
+ | `newton` | newtons: the force that gives a kilogram one metre per second squared |
105
106
  | `mps` | metres per second |
106
107
  | `mps2` | metres per second squared |
107
108
  | `radps` | radians per second |
@@ -113,7 +114,7 @@ Field units the docs and Tune use.
113
114
 
114
115
  ## Every name
115
116
 
116
- 908 entries: modules' functions, types, records, column kinds and constants, and every interface member and resource method.
117
+ 910 entries: modules' functions, types, records, column kinds and constants, and every interface member and resource method.
117
118
 
118
119
  | Name | Kind | Page | Binding symbol |
119
120
  |---|---|---|---|
@@ -734,6 +735,7 @@ Field units the docs and Tune use.
734
735
  | [`og.WaterSurface`](physics.md#record-WaterSurface) | component | physics | — |
735
736
  | [`og.Weather`](atmosphere.md#record-Weather) | resource | atmosphere | — |
736
737
  | [`og.Wheel`](input.md#record-Wheel) | event | input | — |
738
+ | [`og.WorldRestored`](world.md#record-WorldRestored) | event | world | — |
737
739
  | [`OverlapDesc`](physics.md#type-OverlapDesc) | desc struct | physics | — |
738
740
  | [`Paint`](ui.md#type-Paint) | desc struct | ui | — |
739
741
  | [`Palette`](render.md#type-Palette) | handle | render | — |
@@ -741,6 +743,7 @@ Field units the docs and Tune use.
741
743
  | [`PanelDesc`](ui.md#type-PanelDesc) | desc struct | ui | — |
742
744
  | [`ParticleEmitter`](render.md#type-ParticleEmitter) | handle | render | — |
743
745
  | [`ParticleEmitter()`](render.md#column-ParticleEmitter) | column kind | render | — |
746
+ | [`PARTICLES_ARMED`](render.md#const-PARTICLES_ARMED) | constant | render | — |
744
747
  | [`PathDesc`](nav.md#type-PathDesc) | desc struct | nav | — |
745
748
  | [`PauseMenuDesc`](ui.md#type-PauseMenuDesc) | desc struct | ui | — |
746
749
  | [`PercentSize`](ui.md#type-PercentSize) | struct | ui | — |