@origingame/engine 0.3.0 → 0.4.0

package/knowledge/wiki/anim.md

@@ -18,7 +18,7 @@ module anim {
   # declarations follow, each quoted below
 ```
 
-<sub>`api.ogt` line 7139</sub>
+<sub>`api.ogt` line 7707</sub>
 
 ## Contents
 
@@ -68,7 +68,7 @@ module anim {
 | [`Rig2D`](#type-Rig2D) | handle | A 2D rig (a cooked `.ogt` of `type rig2d`): bones, slots, region, mesh, bounding-box and child-armature attachments, IK constraints, child armatures and clips, from og.load.rig2d. |
 | [`Rig2D()`](#column-Rig2D) | column kind | A Rig2D handle field. |
 | [`og.Skeleton2D`](#record-Skeleton2D) | component | Plays a clip of a 2D rig at the entity: the og.skeleton2d system advances it by scaled time (Time.scaledDt) after the game's systems and fires its events as og.Skeleton2DEvent; extraction draws its slots, in their order, as textured triangles of the sprite batch at `layer` (region attachments as quads, mesh attachments weighted to bones and deformed by the clip), lit by og.Lighting2D when the layer is in its range, as a sprite there is. The rig's pixels are `unit` to a world unit and +y is up; the entity's og.Transform places, turns (about z) and scales it. |
-| [`og.Skeleton2DEvent`](#record-Skeleton2DEvent) | event | A 2D skeleton's clip passed one of its events (`event 0.2 "step"` in the rig) in the last tick: footsteps, the frame a swing lands. Read in the tick after, like every event; a clip started at 0 fires its events at 0, a looping clip fires each once per pass. |
+| [`og.Skeleton2DEvent`](#record-Skeleton2DEvent) | event | A 2D skeleton's clip, or the clip a child armature in one of its slots plays, passed one of its events (`event 0.2 "step"` in the rig) in the last tick: footsteps, the frame a swing lands. Read in the tick after, like every event; a clip started at 0 fires its events at 0, a looping clip fires each once per pass. |
 | [`og.IkTarget2D`](#record-IkTarget2D) | component | Moves one IK constraint of a 2D skeleton (Rig2DInfo.constraints) to a point: a foot planted on the ground under it, a hand on a ledge, a tail's tip. A constraint is a chain of any length: one bone points at the target, two are solved exactly (bending the way the rig says), three or more by FABRIK from the animated pose, curling the way the rig says. Put it on its own entity, one per constraint; og.skeleton2d writes `reached` and `error`, and the drawn pose solves the same way. |
 | [`Rig2DClipInfo`](#type-Rig2DClipInfo) | struct | One clip of a loaded 2D rig. |
 | [`Rig2DInfo`](#type-Rig2DInfo) | struct | What og.load.rig2d registered, or og.anim.rig2dInfo reads back from a handle. |
@@ -106,7 +106,7 @@ fn graph {
 }
 ```
 
-<sub>`api.ogt` line 7454</sub>
+<sub>`api.ogt` line 8022</sub>
 
 <a id="fn-humanoid"></a>
 
@@ -136,7 +136,7 @@ fn humanoid {
 }
 ```
 
-<sub>`api.ogt` line 7482</sub>
+<sub>`api.ogt` line 8050</sub>
 
 <a id="fn-retarget"></a>
 
@@ -166,7 +166,7 @@ fn retarget {
 }
 ```
 
-<sub>`api.ogt` line 7502</sub>
+<sub>`api.ogt` line 8070</sub>
 
 <a id="fn-clip"></a>
 
@@ -197,7 +197,7 @@ fn clip {
 }
 ```
 
-<sub>`api.ogt` line 7587</sub>
+<sub>`api.ogt` line 8155</sub>
 
 <a id="fn-clip-2"></a>
 
@@ -228,7 +228,7 @@ fn clip {
 }
 ```
 
-<sub>`api.ogt` line 7595</sub>
+<sub>`api.ogt` line 8163</sub>
 
 <a id="fn-clip-3"></a>
 
@@ -259,7 +259,7 @@ fn clip {
 }
 ```
 
-<sub>`api.ogt` line 7603</sub>
+<sub>`api.ogt` line 8171</sub>
 
 <a id="fn-rig2dInfo"></a>
 
@@ -289,7 +289,7 @@ fn rig2dInfo {
 }
 ```
 
-<sub>`api.ogt` line 7708</sub>
+<sub>`api.ogt` line 8281</sub>
 
 <a id="fn-skeleton2dBoxes"></a>
 
@@ -319,7 +319,7 @@ fn skeleton2dBoxes {
 }
 ```
 
-<sub>`api.ogt` line 7722</sub>
+<sub>`api.ogt` line 8295</sub>
 
 ## Components, resources and events
 
@@ -356,7 +356,7 @@ component Skeleton {
 }
 ```
 
-<sub>`api.ogt` line 7223</sub>
+<sub>`api.ogt` line 7791</sub>
 
 <a id="record-AnimationPlayer"></a>
 
@@ -418,7 +418,7 @@ component AnimationPlayer {
 }
 ```
 
-<sub>`api.ogt` line 7238</sub>
+<sub>`api.ogt` line 7806</sub>
 
 <a id="record-AnimationGraph"></a>
 
@@ -494,7 +494,7 @@ component AnimationGraph {
 }
 ```
 
-<sub>`api.ogt` line 7277</sub>
+<sub>`api.ogt` line 7845</sub>
 
 <a id="record-Blendshapes"></a>
 
@@ -567,7 +567,7 @@ component Blendshapes {
 }
 ```
 
-<sub>`api.ogt` line 7325</sub>
+<sub>`api.ogt` line 7893</sub>
 
 <a id="record-IkChain"></a>
 
@@ -638,7 +638,7 @@ component IkChain {
 }
 ```
 
-<sub>`api.ogt` line 7373</sub>
+<sub>`api.ogt` line 7941</sub>
 
 <a id="record-AnimationEvent"></a>
 
@@ -669,7 +669,7 @@ event AnimationEvent {
 }
 ```
 
-<sub>`api.ogt` line 7417</sub>
+<sub>`api.ogt` line 7985</sub>
 
 <a id="record-Flipbook"></a>
 
@@ -725,7 +725,7 @@ component Flipbook {
 }
 ```
 
-<sub>`api.ogt` line 7525</sub>
+<sub>`api.ogt` line 8093</sub>
 
 <a id="record-FlipbookEvent"></a>
 
@@ -752,7 +752,7 @@ event FlipbookEvent {
 }
 ```
 
-<sub>`api.ogt` line 7556</sub>
+<sub>`api.ogt` line 8124</sub>
 
 <a id="record-Skeleton2D"></a>
 
@@ -773,6 +773,7 @@ Token `og.Skeleton2D`, registered under the schema name `og.Skeleton2D`; its val
 | `loop` | `boolean` | `true` | — | — | — | Wrap at the clip's end; otherwise hold the last pose and set `finished`. Rig2DInfo.clips says what the rig's author meant. |
 | `flipX` | `boolean` | `false` | — | — | — | Mirror the rig left to right about the entity's position (a character facing left). |
 | `layer` | `number` | `0` | — | — | — | The sprite layer it draws in, sorted with the sprites there (after them when they share the layer). |
+| `skin` | `number` | `0` | ≥ 0 | — | — | The skin it wears: an index into Rig2DInfo.skins (0 is the rig's default; `rig.skins.indexOf("armor")` finds one by name). A skin shows its own attachment wherever the setup pose or a clip shows the default's; a slot the skin leaves alone shows the default's. Change it any tick: the pose is drawn from it. |
 | `finished` | `boolean` | `false` | — | — | read only | Written: a clip that does not loop reached its end (or its start, played backwards). |
 
 ```ogt
@@ -798,19 +799,22 @@ component Skeleton2D {
   }
   field flipX bool "Mirror the rig left to right about the entity's position (a character facing left)."
   field layer i32 "The sprite layer it draws in, sorted with the sprites there (after them when they share the layer)."
+  field skin u32 "The skin it wears: an index into Rig2DInfo.skins (0 is the rig's default; `rig.skins.indexOf(\"armor\")` finds one by name). A skin shows its own attachment wherever the setup pose or a clip shows the default's; a slot the skin leaves alone shows the default's. Change it any tick: the pose is drawn from it." {
+    min 0
+  }
   field finished bool "Written: a clip that does not loop reached its end (or its start, played backwards)." {
     readonly true
   }
 }
 ```
 
-<sub>`api.ogt` line 7620</sub>
+<sub>`api.ogt` line 8188</sub>
 
 <a id="record-Skeleton2DEvent"></a>
 
 ### `og.Skeleton2DEvent` (event)
 
-A 2D skeleton's clip passed one of its events (`event 0.2 "step"` in the rig) in the last tick: footsteps, the frame a swing lands. Read in the tick after, like every event; a clip started at 0 fires its events at 0, a looping clip fires each once per pass.
+A 2D skeleton's clip, or the clip a child armature in one of its slots plays, passed one of its events (`event 0.2 "step"` in the rig) in the last tick: footsteps, the frame a swing lands. Read in the tick after, like every event; a clip started at 0 fires its events at 0, a looping clip fires each once per pass.
 
 Token `og.Skeleton2DEvent`, registered under the schema name `og.Skeleton2DEvent`; its value type is `Skeleton2DEvent`.
 
@@ -820,20 +824,22 @@ Token `og.Skeleton2DEvent`, registered under the schema name `og.Skeleton2DEvent
 | `clip` | `number` | `0` | — | — | — | The clip index. |
 | `name` | `string` | `""` | — | — | — | The event's name (at most 63 bytes). |
 | `time` | `number` | `0` | — | `s` | — | The event's time in the clip. |
+| `armature` | `string` | `""` | — | — | — | Empty for the skeleton's own clip; for an event of a child armature shown in one of its slots, that armature's name (`clip` and `time` are then the child's clip and its time): a flame's crackle apart from the keeper's footsteps (at most 63 bytes). |
 
 ```ogt
 event Skeleton2DEvent {
-  doc "A 2D skeleton's clip passed one of its events (`event 0.2 \"step\"` in the rig) in the last tick: footsteps, the frame a swing lands. Read in the tick after, like every event; a clip started at 0 fires its events at 0, a looping clip fires each once per pass."
+  doc "A 2D skeleton's clip, or the clip a child armature in one of its slots plays, passed one of its events (`event 0.2 \"step\"` in the rig) in the last tick: footsteps, the frame a swing lands. Read in the tick after, like every event; a clip started at 0 fires its events at 0, a looping clip fires each once per pass."
   field entity Entity "The entity with the og.Skeleton2D."
   field clip u32 "The clip index."
   field name String "The event's name (at most 63 bytes)."
   field time f32 "The event's time in the clip." {
     unit s
   }
+  field armature String "Empty for the skeleton's own clip; for an event of a child armature shown in one of its slots, that armature's name (`clip` and `time` are then the child's clip and its time): a flame's crackle apart from the keeper's footsteps (at most 63 bytes)."
 }
 ```
 
-<sub>`api.ogt` line 7647</sub>
+<sub>`api.ogt` line 8218</sub>
 
 <a id="record-IkTarget2D"></a>
 
@@ -884,7 +890,7 @@ component IkTarget2D {
 }
 ```
 
-<sub>`api.ogt` line 7657</sub>
+<sub>`api.ogt` line 8229</sub>
 
 ## Types
 
@@ -900,7 +906,7 @@ A generational handle: a number the engine hands out. A dead handle is an error
 handle SkeletonAsset "A rig: a glTF's nodes in topological order with their rest transforms, and its skins (joints and inverse bind matrices)."
 ```
 
-<sub>`api.ogt` line 7145</sub>
+<sub>`api.ogt` line 7713</sub>
 
 <a id="type-ClipAsset"></a>
 
@@ -914,7 +920,7 @@ A generational handle: a number the engine hands out. A dead handle is an error
 handle ClipAsset "An animation clip, resampled at the cook's rate, with its markers."
 ```
 
-<sub>`api.ogt` line 7146</sub>
+<sub>`api.ogt` line 7714</sub>
 
 <a id="type-GraphAsset"></a>
 
@@ -928,7 +934,7 @@ A generational handle: a number the engine hands out. A dead handle is an error
 handle GraphAsset "A blend-tree graph (`type animgraph`) whose clip references were resolved to clip handles."
 ```
 
-<sub>`api.ogt` line 7147</sub>
+<sub>`api.ogt` line 7715</sub>
 
 <a id="type-RootMotion"></a>
 
@@ -953,7 +959,7 @@ enum RootMotion {
 }
 ```
 
-<sub>`api.ogt` line 7170</sub>
+<sub>`api.ogt` line 7738</sub>
 
 <a id="type-BlendshapeSource"></a>
 
@@ -976,7 +982,7 @@ enum BlendshapeSource {
 }
 ```
 
-<sub>`api.ogt` line 7184</sub>
+<sub>`api.ogt` line 7752</sub>
 
 <a id="type-IkSolver"></a>
 
@@ -999,7 +1005,7 @@ enum IkSolver {
 }
 ```
 
-<sub>`api.ogt` line 7197</sub>
+<sub>`api.ogt` line 7765</sub>
 
 <a id="type-IkSpace"></a>
 
@@ -1022,7 +1028,7 @@ enum IkSpace {
 }
 ```
 
-<sub>`api.ogt` line 7210</sub>
+<sub>`api.ogt` line 7778</sub>
 
 <a id="type-ClipInfo"></a>
 
@@ -1049,7 +1055,7 @@ struct ClipInfo {
 }
 ```
 
-<sub>`api.ogt` line 7428</sub>
+<sub>`api.ogt` line 7996</sub>
 
 <a id="type-Animation"></a>
 
@@ -1076,7 +1082,7 @@ struct Animation {
 }
 ```
 
-<sub>`api.ogt` line 7438</sub>
+<sub>`api.ogt` line 8006</sub>
 
 <a id="type-GraphDesc"></a>
 
@@ -1100,7 +1106,7 @@ struct GraphDesc {
 }
 ```
 
-<sub>`api.ogt` line 7447</sub>
+<sub>`api.ogt` line 8015</sub>
 
 <a id="type-Rig"></a>
 
@@ -1114,7 +1120,7 @@ A generational handle: a number the engine hands out. A dead handle is an error
 handle Rig "A humanoid map from og.load.rig (a cooked `.ogt` of `type rig`): the naming scheme a skeleton's node names follow and the standard bones it names outright."
 ```
 
-<sub>`api.ogt` line 7461</sub>
+<sub>`api.ogt` line 8029</sub>
 
 <a id="type-HumanBone"></a>
 
@@ -1135,7 +1141,7 @@ struct HumanBone {
 }
 ```
 
-<sub>`api.ogt` line 7463</sub>
+<sub>`api.ogt` line 8031</sub>
 
 <a id="type-Humanoid"></a>
 
@@ -1156,7 +1162,7 @@ struct Humanoid {
 }
 ```
 
-<sub>`api.ogt` line 7469</sub>
+<sub>`api.ogt` line 8037</sub>
 
 <a id="type-HumanoidDesc"></a>
 
@@ -1180,7 +1186,7 @@ struct HumanoidDesc {
 }
 ```
 
-<sub>`api.ogt` line 7475</sub>
+<sub>`api.ogt` line 8043</sub>
 
 <a id="type-RetargetDesc"></a>
 
@@ -1214,7 +1220,7 @@ struct RetargetDesc {
 }
 ```
 
-<sub>`api.ogt` line 7489</sub>
+<sub>`api.ogt` line 8057</sub>
 
 <a id="type-FlipbookSheet"></a>
 
@@ -1228,7 +1234,7 @@ A generational handle: a number the engine hands out. A dead handle is an error
 handle FlipbookSheet "A sprite sheet's frames and clips (a cooked `.ogt` of `type flipbook`), from og.load.flipbook."
 ```
 
-<sub>`api.ogt` line 7509</sub>
+<sub>`api.ogt` line 8077</sub>
 
 <a id="type-FlipMode"></a>
 
@@ -1253,7 +1259,7 @@ enum FlipMode {
 }
 ```
 
-<sub>`api.ogt` line 7518</sub>
+<sub>`api.ogt` line 8086</sub>
 
 <a id="type-FlipbookClipInfo"></a>
 
@@ -1284,7 +1290,7 @@ struct FlipbookClipInfo {
 }
 ```
 
-<sub>`api.ogt` line 7564</sub>
+<sub>`api.ogt` line 8132</sub>
 
 <a id="type-FlipbookInfo"></a>
 
@@ -1315,7 +1321,7 @@ struct FlipbookInfo {
 }
 ```
 
-<sub>`api.ogt` line 7576</sub>
+<sub>`api.ogt` line 8144</sub>
 
 <a id="type-Rig2D"></a>
 
@@ -1329,7 +1335,7 @@ A generational handle: a number the engine hands out. A dead handle is an error
 handle Rig2D "A 2D rig (a cooked `.ogt` of `type rig2d`): bones, slots, region, mesh, bounding-box and child-armature attachments, IK constraints, child armatures and clips, from og.load.rig2d."
 ```
 
-<sub>`api.ogt` line 7611</sub>
+<sub>`api.ogt` line 8179</sub>
 
 <a id="type-Rig2DClipInfo"></a>
 
@@ -1358,7 +1364,7 @@ struct Rig2DClipInfo {
 }
 ```
 
-<sub>`api.ogt` line 7686</sub>
+<sub>`api.ogt` line 8258</sub>
 
 <a id="type-Rig2DInfo"></a>
 
@@ -1374,6 +1380,7 @@ What og.load.rig2d registered, or og.anim.rig2dInfo reads back from a handle.
 | `bones` | `readonly string[]` | `[]` | — | — | — | The bones' names, parents first. |
 | `slots` | `readonly string[]` | `[]` | — | — | — | The slots' names, in draw order. |
 | `constraints` | `readonly string[]` | `[]` | — | — | — | The IK constraints' names: an index here is IkTarget2D.constraint. |
+| `skins` | `readonly string[]` | `[]` | — | — | — | Its skins' names, `default` (the rig's own attachments) first: an index here is Skeleton2D.skin. |
 | `clips` | `readonly Rig2DClipInfo[]` | `[]` | — | — | — | Its clips, in file order. |
 
 ```ogt
@@ -1385,11 +1392,12 @@ struct Rig2DInfo {
   field bones List.String "The bones' names, parents first."
   field slots List.String "The slots' names, in draw order."
   field constraints List.String "The IK constraints' names: an index here is IkTarget2D.constraint."
+  field skins List.String "Its skins' names, `default` (the rig's own attachments) first: an index here is Skeleton2D.skin."
   field clips List.Rig2DClipInfo "Its clips, in file order."
 }
 ```
 
-<sub>`api.ogt` line 7697</sub>
+<sub>`api.ogt` line 8269</sub>
 
 <a id="type-Skeleton2DBox"></a>
 
@@ -1412,7 +1420,7 @@ struct Skeleton2DBox {
 }
 ```
 
-<sub>`api.ogt` line 7715</sub>
+<sub>`api.ogt` line 8288</sub>
 
 ## Column kinds
 
@@ -1439,7 +1447,7 @@ column SkeletonAsset {
 }
 ```
 
-<sub>`api.ogt` line 7149</sub>
+<sub>`api.ogt` line 7717</sub>
 
 ```ogt
 column ClipAsset {
@@ -1450,7 +1458,7 @@ column ClipAsset {
 }
 ```
 
-<sub>`api.ogt` line 7156</sub>
+<sub>`api.ogt` line 7724</sub>
 
 ```ogt
 column GraphAsset {
@@ -1461,7 +1469,7 @@ column GraphAsset {
 }
 ```
 
-<sub>`api.ogt` line 7163</sub>
+<sub>`api.ogt` line 7731</sub>
 
 ```ogt
 column RootMotion {
@@ -1472,7 +1480,7 @@ column RootMotion {
 }
 ```
 
-<sub>`api.ogt` line 7177</sub>
+<sub>`api.ogt` line 7745</sub>
 
 ```ogt
 column BlendshapeSource {
@@ -1483,7 +1491,7 @@ column BlendshapeSource {
 }
 ```
 
-<sub>`api.ogt` line 7190</sub>
+<sub>`api.ogt` line 7758</sub>
 
 ```ogt
 column IkSolver {
@@ -1494,7 +1502,7 @@ column IkSolver {
 }
 ```
 
-<sub>`api.ogt` line 7203</sub>
+<sub>`api.ogt` line 7771</sub>
 
 ```ogt
 column IkSpace {
@@ -1505,7 +1513,7 @@ column IkSpace {
 }
 ```
 
-<sub>`api.ogt` line 7216</sub>
+<sub>`api.ogt` line 7784</sub>
 
 ```ogt
 column FlipbookSheet {
@@ -1516,7 +1524,7 @@ column FlipbookSheet {
 }
 ```
 
-<sub>`api.ogt` line 7511</sub>
+<sub>`api.ogt` line 8079</sub>
 
 ```ogt
 column Rig2D {
@@ -1527,4 +1535,4 @@ column Rig2D {
 }
 ```
 
-<sub>`api.ogt` line 7613</sub>
+<sub>`api.ogt` line 8181</sub>

package/knowledge/wiki/atmosphere.md

@@ -16,7 +16,7 @@ module atmosphere {
   # declarations follow, each quoted below
 ```
 
-<sub>`api.ogt` line 6734</sub>
+<sub>`api.ogt` line 7302</sub>
 
 ## Contents
 
@@ -63,7 +63,7 @@ fn timeOfDay {
 }
 ```
 
-<sub>`api.ogt` line 7130</sub>
+<sub>`api.ogt` line 7698</sub>
 
 ## Components, resources and events
 
@@ -177,7 +177,7 @@ resource Fog {
 }
 ```
 
-<sub>`api.ogt` line 6745</sub>
+<sub>`api.ogt` line 7313</sub>
 
 <a id="record-Sky"></a>
 
@@ -284,7 +284,7 @@ resource Sky {
 }
 ```
 
-<sub>`api.ogt` line 6826</sub>
+<sub>`api.ogt` line 7394</sub>
 
 <a id="record-DayNight"></a>
 
@@ -366,7 +366,7 @@ resource DayNight {
 }
 ```
 
-<sub>`api.ogt` line 6901</sub>
+<sub>`api.ogt` line 7469</sub>
 
 <a id="record-Weather"></a>
 
@@ -428,7 +428,7 @@ resource Weather {
 }
 ```
 
-<sub>`api.ogt` line 6958</sub>
+<sub>`api.ogt` line 7526</sub>
 
 <a id="record-Water"></a>
 
@@ -562,7 +562,7 @@ component Water {
 }
 ```
 
-<sub>`api.ogt` line 6998</sub>
+<sub>`api.ogt` line 7566</sub>
 
 <a id="record-Water2D"></a>
 
@@ -616,7 +616,7 @@ component Water2D {
 }
 ```
 
-<sub>`api.ogt` line 7098</sub>
+<sub>`api.ogt` line 7666</sub>
 
 ## Constants
 
@@ -632,28 +632,28 @@ component Water2D {
 const WEATHER_NONE u32 0 "Weather.kind: clear."
 ```
 
-<sub>`api.ogt` line 6739</sub>
+<sub>`api.ogt` line 7307</sub>
 
 ```ogt
 const WEATHER_RAIN u32 1 "Weather.kind: rain streaks falling with the wind, the light dimmed and a grey distance fog."
 ```
 
-<sub>`api.ogt` line 6740</sub>
+<sub>`api.ogt` line 7308</sub>
 
 ```ogt
 const WEATHER_SNOW u32 2 "Weather.kind: flakes drifting down on gusts, a pale fog."
 ```
 
-<sub>`api.ogt` line 6741</sub>
+<sub>`api.ogt` line 7309</sub>
 
 ```ogt
 const WEATHER_DUST u32 3 "Weather.kind: dust blowing along the wind near the ground, a warm thick fog."
 ```
 
-<sub>`api.ogt` line 6742</sub>
+<sub>`api.ogt` line 7310</sub>
 
 ```ogt
 const WEATHER_MIST u32 4 "Weather.kind: no particles, a dense low height fog."
 ```
 
-<sub>`api.ogt` line 6743</sub>
+<sub>`api.ogt` line 7311</sub>