@origingame/engine 0.1.1 → 0.2.0

package/knowledge/wiki/rng.md

@@ -16,7 +16,7 @@ module rng {
   # declarations follow, each quoted below
 ```
 
-<sub>`api.ogt` line 641</sub>
+<sub>`api.ogt` line 652</sub>
 
 ## Contents
 
@@ -78,7 +78,7 @@ resource Rng {
 }
 ```
 
-<sub>`api.ogt` line 677</sub>
+<sub>`api.ogt` line 688</sub>
 
 <a id="member-Rng-next"></a>
 
@@ -101,7 +101,7 @@ fn next {
 }
 ```
 
-<sub>`api.ogt` line 685</sub>
+<sub>`api.ogt` line 696</sub>
 
 <a id="member-Rng-range"></a>
 
@@ -131,7 +131,7 @@ fn range {
 }
 ```
 
-<sub>`api.ogt` line 689</sub>
+<sub>`api.ogt` line 700</sub>
 
 <a id="member-Rng-integer"></a>
 
@@ -161,7 +161,7 @@ fn integer {
 }
 ```
 
-<sub>`api.ogt` line 695</sub>
+<sub>`api.ogt` line 706</sub>
 
 <a id="member-Rng-chance"></a>
 
@@ -189,7 +189,7 @@ fn chance {
 }
 ```
 
-<sub>`api.ogt` line 701</sub>
+<sub>`api.ogt` line 712</sub>
 
 <a id="member-Rng-fork"></a>
 
@@ -217,7 +217,7 @@ fn fork {
 }
 ```
 
-<sub>`api.ogt` line 706</sub>
+<sub>`api.ogt` line 717</sub>
 
 ## Interfaces
 
@@ -233,7 +233,7 @@ interface RngStream {
   # members follow, each quoted below
 ```
 
-<sub>`api.ogt` line 646</sub>
+<sub>`api.ogt` line 657</sub>
 
 <a id="member-RngStream-seed"></a>
 
@@ -251,7 +251,7 @@ Binding symbol `og_rng_stream_get_seed` · publish builds: kept
 prop seed u32 "The stream's derived seed."
 ```
 
-<sub>`api.ogt` line 648</sub>
+<sub>`api.ogt` line 659</sub>
 
 <a id="member-RngStream-next"></a>
 
@@ -274,7 +274,7 @@ fn next {
 }
 ```
 
-<sub>`api.ogt` line 649</sub>
+<sub>`api.ogt` line 660</sub>
 
 <a id="member-RngStream-range"></a>
 
@@ -304,7 +304,7 @@ fn range {
 }
 ```
 
-<sub>`api.ogt` line 653</sub>
+<sub>`api.ogt` line 664</sub>
 
 <a id="member-RngStream-integer"></a>
 
@@ -334,7 +334,7 @@ fn integer {
 }
 ```
 
-<sub>`api.ogt` line 659</sub>
+<sub>`api.ogt` line 670</sub>
 
 <a id="member-RngStream-chance"></a>
 
@@ -362,7 +362,7 @@ fn chance {
 }
 ```
 
-<sub>`api.ogt` line 665</sub>
+<sub>`api.ogt` line 676</sub>
 
 <a id="member-RngStream-fork"></a>
 
@@ -390,4 +390,4 @@ fn fork {
 }
 ```
 
-<sub>`api.ogt` line 670</sub>
+<sub>`api.ogt` line 681</sub>

package/knowledge/wiki/stream.md

@@ -22,7 +22,7 @@ module stream {
   # declarations follow, each quoted below
 ```
 
-<sub>`api.ogt` line 11257</sub>
+<sub>`api.ogt` line 11322</sub>
 
 ## Contents
 
@@ -73,7 +73,7 @@ fn status {
 }
 ```
 
-<sub>`api.ogt` line 11327</sub>
+<sub>`api.ogt` line 11392</sub>
 
 <a id="fn-request"></a>
 
@@ -103,7 +103,7 @@ fn request {
 }
 ```
 
-<sub>`api.ogt` line 11334</sub>
+<sub>`api.ogt` line 11399</sub>
 
 <a id="fn-release"></a>
 
@@ -133,7 +133,7 @@ fn release {
 }
 ```
 
-<sub>`api.ogt` line 11341</sub>
+<sub>`api.ogt` line 11406</sub>
 
 <a id="fn-budget"></a>
 
@@ -161,7 +161,7 @@ fn budget {
 }
 ```
 
-<sub>`api.ogt` line 11348</sub>
+<sub>`api.ogt` line 11413</sub>
 
 <a id="fn-setBudget"></a>
 
@@ -191,7 +191,7 @@ fn setBudget {
 }
 ```
 
-<sub>`api.ogt` line 11354</sub>
+<sub>`api.ogt` line 11419</sub>
 
 ## Components, resources and events
 
@@ -216,7 +216,7 @@ event StreamEvent {
 }
 ```
 
-<sub>`api.ogt` line 11280</sub>
+<sub>`api.ogt` line 11345</sub>
 
 ## Types
 
@@ -247,7 +247,7 @@ enum StreamState {
 }
 ```
 
-<sub>`api.ogt` line 11265</sub>
+<sub>`api.ogt` line 11330</sub>
 
 <a id="type-StreamStatus"></a>
 
@@ -298,7 +298,7 @@ struct StreamStatus {
 }
 ```
 
-<sub>`api.ogt` line 11286</sub>
+<sub>`api.ogt` line 11351</sub>
 
 <a id="type-StreamBudget"></a>
 
@@ -333,7 +333,7 @@ struct StreamBudget {
 }
 ```
 
-<sub>`api.ogt` line 11310</sub>
+<sub>`api.ogt` line 11375</sub>
 
 ## Constants
 
@@ -349,28 +349,28 @@ struct StreamBudget {
 const STREAM_UNLOADED u32 0 "`StreamEvent.state`: the group is unloaded (StreamState unloaded)."
 ```
 
-<sub>`api.ogt` line 11274</sub>
+<sub>`api.ogt` line 11339</sub>
 
 ```ogt
 const STREAM_QUEUED u32 1 "`StreamEvent.state`: the group waits for room in the budget (StreamState queued)."
 ```
 
-<sub>`api.ogt` line 11275</sub>
+<sub>`api.ogt` line 11340</sub>
 
 ```ogt
 const STREAM_LOADING u32 2 "`StreamEvent.state`: the group's pack is being read (StreamState loading)."
 ```
 
-<sub>`api.ogt` line 11276</sub>
+<sub>`api.ogt` line 11341</sub>
 
 ```ogt
 const STREAM_RESIDENT u32 3 "`StreamEvent.state`: the group's assets are in place (StreamState resident)."
 ```
 
-<sub>`api.ogt` line 11277</sub>
+<sub>`api.ogt` line 11342</sub>
 
 ```ogt
 const STREAM_FAILED u32 4 "`StreamEvent.state`: the group failed (StreamState failed; og.stream.status says why)."
 ```
 
-<sub>`api.ogt` line 11278</sub>
+<sub>`api.ogt` line 11343</sub>

package/knowledge/wiki/system.md

@@ -20,7 +20,7 @@ module system {
   # declarations follow, each quoted below
 ```
 
-<sub>`api.ogt` line 417</sub>
+<sub>`api.ogt` line 428</sub>
 
 ## Contents
 
@@ -63,7 +63,7 @@ fn defineSystem {
 }
 ```
 
-<sub>`api.ogt` line 449</sub>
+<sub>`api.ogt` line 460</sub>
 
 ## Interfaces
 
@@ -79,7 +79,7 @@ interface System {
   # members follow, each quoted below
 ```
 
-<sub>`api.ogt` line 442</sub>
+<sub>`api.ogt` line 453</sub>
 
 <a id="member-System-name"></a>
 
@@ -97,7 +97,7 @@ Binding symbol `og_system_get_name` · publish builds: kept
 prop name String "The system's unique name."
 ```
 
-<sub>`api.ogt` line 444</sub>
+<sub>`api.ogt` line 455</sub>
 
 <a id="member-System-reads"></a>
 
@@ -115,7 +115,7 @@ Binding symbol `og_system_get_reads` · publish builds: kept
 prop reads List.AnyReflected "What it reads."
 ```
 
-<sub>`api.ogt` line 445</sub>
+<sub>`api.ogt` line 456</sub>
 
 <a id="member-System-writes"></a>
 
@@ -133,7 +133,7 @@ Binding symbol `og_system_get_writes` · publish builds: kept
 prop writes List.AnyReflected "What it writes."
 ```
 
-<sub>`api.ogt` line 446</sub>
+<sub>`api.ogt` line 457</sub>
 
 ## Types
 
@@ -165,7 +165,7 @@ struct SystemDesc {
 }
 ```
 
-<sub>`api.ogt` line 425</sub>
+<sub>`api.ogt` line 436</sub>
 
 <a id="type-SystemRun"></a>
 
@@ -194,4 +194,4 @@ callback SystemRun {
 }
 ```
 
-<sub>`api.ogt` line 435</sub>
+<sub>`api.ogt` line 446</sub>

package/knowledge/wiki/systems.md

@@ -14,7 +14,7 @@ module systems {
   # declarations follow, each quoted below
 ```
 
-<sub>`api.ogt` line 10346</sub>
+<sub>`api.ogt` line 10411</sub>
 
 ## Contents
 
@@ -40,4 +40,4 @@ const cameras: readonly System[]
 value cameras List.System "The camera controllers, in this order: og.orbitCamera (og.OrbitCamera), og.followCamera (og.FollowCamera) and og.follow2D (og.Follow2D). Each moves og.Camera only while an entity carries its component. List them before the game's systems that read og.Camera: `systems: [...og.systems.cameras, ...yours]`."
 ```
 
-<sub>`api.ogt` line 10350</sub>
+<sub>`api.ogt` line 10415</sub>

package/knowledge/wiki/terrain.md

@@ -18,7 +18,7 @@ module terrain {
   # declarations follow, each quoted below
 ```
 
-<sub>`api.ogt` line 10947</sub>
+<sub>`api.ogt` line 11012</sub>
 
 ## Contents
 
@@ -73,7 +73,7 @@ fn load {
 }
 ```
 
-<sub>`api.ogt` line 11199</sub>
+<sub>`api.ogt` line 11264</sub>
 
 <a id="fn-sample"></a>
 
@@ -103,7 +103,7 @@ fn sample {
 }
 ```
 
-<sub>`api.ogt` line 11206</sub>
+<sub>`api.ogt` line 11271</sub>
 
 <a id="fn-bounds"></a>
 
@@ -145,7 +145,7 @@ fn bounds {
 }
 ```
 
-<sub>`api.ogt` line 11213</sub>
+<sub>`api.ogt` line 11278</sub>
 
 <a id="fn-edit"></a>
 
@@ -177,7 +177,7 @@ fn edit {
 }
 ```
 
-<sub>`api.ogt` line 11229</sub>
+<sub>`api.ogt` line 11294</sub>
 
 <a id="fn-layer"></a>
 
@@ -209,7 +209,7 @@ fn layer {
 }
 ```
 
-<sub>`api.ogt` line 11237</sub>
+<sub>`api.ogt` line 11302</sub>
 
 <a id="fn-setLayer"></a>
 
@@ -243,7 +243,7 @@ fn setLayer {
 }
 ```
 
-<sub>`api.ogt` line 11245</sub>
+<sub>`api.ogt` line 11310</sub>
 
 ## Components, resources and events
 
@@ -282,7 +282,7 @@ component Terrain {
 }
 ```
 
-<sub>`api.ogt` line 10971</sub>
+<sub>`api.ogt` line 11036</sub>
 
 <a id="record-TerrainScatter"></a>
 
@@ -357,7 +357,7 @@ component TerrainScatter {
 }
 ```
 
-<sub>`api.ogt` line 10989</sub>
+<sub>`api.ogt` line 11054</sub>
 
 ## Types
 
@@ -373,7 +373,7 @@ A generational handle: a number the engine hands out. A dead handle is an error
 handle TerrainData "A loaded terrain: its heights, control map and layers."
 ```
 
-<sub>`api.ogt` line 10953</sub>
+<sub>`api.ogt` line 11018</sub>
 
 <a id="type-TerrainBrushMode"></a>
 
@@ -402,7 +402,7 @@ enum TerrainBrushMode {
 }
 ```
 
-<sub>`api.ogt` line 10962</sub>
+<sub>`api.ogt` line 11027</sub>
 
 <a id="type-TerrainInfo"></a>
 
@@ -445,7 +445,7 @@ struct TerrainInfo {
 }
 ```
 
-<sub>`api.ogt` line 11038</sub>
+<sub>`api.ogt` line 11103</sub>
 
 <a id="type-TerrainSampleDesc"></a>
 
@@ -485,7 +485,7 @@ struct TerrainSampleDesc {
 }
 ```
 
-<sub>`api.ogt` line 11058</sub>
+<sub>`api.ogt` line 11123</sub>
 
 <a id="type-TerrainSample"></a>
 
@@ -514,7 +514,7 @@ struct TerrainSample {
 }
 ```
 
-<sub>`api.ogt` line 11077</sub>
+<sub>`api.ogt` line 11142</sub>
 
 <a id="type-TerrainBounds"></a>
 
@@ -539,7 +539,7 @@ struct TerrainBounds {
 }
 ```
 
-<sub>`api.ogt` line 11089</sub>
+<sub>`api.ogt` line 11154</sub>
 
 <a id="type-TerrainBrush"></a>
 
@@ -597,7 +597,7 @@ struct TerrainBrush {
 }
 ```
 
-<sub>`api.ogt` line 11099</sub>
+<sub>`api.ogt` line 11164</sub>
 
 <a id="type-TerrainEdit"></a>
 
@@ -624,7 +624,7 @@ struct TerrainEdit {
 }
 ```
 
-<sub>`api.ogt` line 11133</sub>
+<sub>`api.ogt` line 11198</sub>
 
 <a id="type-TerrainLayerDesc"></a>
 
@@ -705,7 +705,7 @@ struct TerrainLayerDesc {
 }
 ```
 
-<sub>`api.ogt` line 11144</sub>
+<sub>`api.ogt` line 11209</sub>
 
 ## Column kinds
 
@@ -724,4 +724,4 @@ column TerrainData {
 }
 ```
 
-<sub>`api.ogt` line 10955</sub>
+<sub>`api.ogt` line 11020</sub>

package/knowledge/wiki/tilemap.md

@@ -20,7 +20,7 @@ module tilemap {
   # declarations follow, each quoted below
 ```
 
-<sub>`api.ogt` line 6263</sub>
+<sub>`api.ogt` line 6293</sub>
 
 ## Contents
 
@@ -69,7 +69,7 @@ fn setTile {
 }
 ```
 
-<sub>`api.ogt` line 6371</sub>
+<sub>`api.ogt` line 6403</sub>
 
 <a id="fn-getTile"></a>
 
@@ -105,7 +105,7 @@ fn getTile {
 }
 ```
 
-<sub>`api.ogt` line 6378</sub>
+<sub>`api.ogt` line 6410</sub>
 
 <a id="fn-cellAt"></a>
 
@@ -137,7 +137,7 @@ fn cellAt {
 }
 ```
 
-<sub>`api.ogt` line 6388</sub>
+<sub>`api.ogt` line 6420</sub>
 
 <a id="fn-cellCenter"></a>
 
@@ -171,7 +171,7 @@ fn cellCenter {
 }
 ```
 
-<sub>`api.ogt` line 6396</sub>
+<sub>`api.ogt` line 6428</sub>
 
 ## Components, resources and events
 
@@ -191,7 +191,7 @@ Token `og.Tilemap`, registered under the schema name `og.Tilemap`; its value typ
 | `opacity` | `number` | `1` | 0 … 1 | — | — | The alpha, times each layer's. |
 | `visible` | `boolean` | `true` | — | — | — | Whether it is drawn. |
 | `collision` | `boolean` | `true` | — | — | — | Give the layers marked collision static colliders (rectangles merged from the solid tiles). |
-| `colliderLayers` | `number` | `1` | — | — | — | The collision layers of those colliders, as bits (Collider.layers). |
+| `colliderLayers` | `number` | `1` | — | — | — | The collision layers of those colliders, as bits (Collider.layers), for every collision layer of the map that names none of its own (a map layer's `colliderLayers`, with its `colliderMask`, puts a layer of grates on a one-way layer while the walls stay here). |
 | `friction` | `number` | `0.5` | 0 … 2 | — | — | The colliders' friction. |
 
 ```ogt
@@ -215,7 +215,7 @@ component Tilemap {
   field collision bool "Give the layers marked collision static colliders (rectangles merged from the solid tiles)." {
     default true
   }
-  field colliderLayers u32 "The collision layers of those colliders, as bits (Collider.layers)." {
+  field colliderLayers u32 "The collision layers of those colliders, as bits (Collider.layers), for every collision layer of the map that names none of its own (a map layer's `colliderLayers`, with its `colliderMask`, puts a layer of grates on a one-way layer while the walls stay here)." {
     default 1
   }
   field friction f32 "The colliders' friction." {
@@ -226,7 +226,7 @@ component Tilemap {
 }
 ```
 
-<sub>`api.ogt` line 6279</sub>
+<sub>`api.ogt` line 6309</sub>
 
 ## Types
 
@@ -242,7 +242,7 @@ A generational handle: a number the engine hands out. A dead handle is an error
 handle TilemapAsset "A loaded map: its layers, tilesets and objects."
 ```
 
-<sub>`api.ogt` line 6270</sub>
+<sub>`api.ogt` line 6300</sub>
 
 <a id="type-TileLayerInfo"></a>
 
@@ -257,6 +257,8 @@ One layer of a map.
 | `z` | `number` | `0` | — | — | — | Its sprite-layer offset from Tilemap.layer. |
 | `parallax` | `Vector2` | `{ x: 0, y: 0 }` | — | — | — | Its scroll factors: 1 1 moves with the world, 0.5 at half the camera's speed (far away), 0 stays with the camera. |
 | `collision` | `boolean` | `false` | — | — | — | Its solid tiles collide. |
+| `colliderLayers` | `number` | `0` | — | — | — | The collision layers (og.Collider.layers bits) of its colliders, from its `colliderLayers` line or Tiled int property; 0 (unset) takes Tilemap.colliderLayers. |
+| `colliderMask` | `number` | `0` | — | — | — | The layers its colliders collide with (og.Collider.mask bits), from its `colliderMask` line or Tiled int property; 0 (unset) is every layer. |
 | `terrain` | `string` | `""` | — | — | — | The auto-tiling terrain of a terrain layer (its cells are 1 filled or 0 empty); empty for a tile layer. |
 | `visible` | `boolean` | `false` | — | — | — | Whether it is drawn. |
 | `lit` | `boolean` | `false` | — | — | — | Whether og.Lighting2D lights it when its sprite layer is in the lit range (true unless the Tiled layer's bool property `lit` or the `.ogt` layer's `lit` line says false). |
@@ -269,13 +271,15 @@ struct TileLayerInfo {
   field z i32 "Its sprite-layer offset from Tilemap.layer."
   field parallax Vector2 "Its scroll factors: 1 1 moves with the world, 0.5 at half the camera's speed (far away), 0 stays with the camera."
   field collision bool "Its solid tiles collide."
+  field colliderLayers u32 "The collision layers (og.Collider.layers bits) of its colliders, from its `colliderLayers` line or Tiled int property; 0 (unset) takes Tilemap.colliderLayers."
+  field colliderMask u32 "The layers its colliders collide with (og.Collider.mask bits), from its `colliderMask` line or Tiled int property; 0 (unset) is every layer."
   field terrain String "The auto-tiling terrain of a terrain layer (its cells are 1 filled or 0 empty); empty for a tile layer."
   field visible bool "Whether it is drawn."
   field lit bool "Whether og.Lighting2D lights it when its sprite layer is in the lit range (true unless the Tiled layer's bool property `lit` or the `.ogt` layer's `lit` line says false)."
 }
 ```
 
-<sub>`api.ogt` line 6309</sub>
+<sub>`api.ogt` line 6339</sub>
 
 <a id="type-TileObject"></a>
 
@@ -310,7 +314,7 @@ struct TileObject {
 }
 ```
 
-<sub>`api.ogt` line 6321</sub>
+<sub>`api.ogt` line 6353</sub>
 
 <a id="type-TilemapInfo"></a>
 
@@ -345,7 +349,7 @@ struct TilemapInfo {
 }
 ```
 
-<sub>`api.ogt` line 6337</sub>
+<sub>`api.ogt` line 6369</sub>
 
 <a id="type-SetTileDesc"></a>
 
@@ -377,7 +381,7 @@ struct SetTileDesc {
 }
 ```
 
-<sub>`api.ogt` line 6352</sub>
+<sub>`api.ogt` line 6384</sub>
 
 <a id="type-TileCell"></a>
 
@@ -400,7 +404,7 @@ struct TileCell {
 }
 ```
 
-<sub>`api.ogt` line 6364</sub>
+<sub>`api.ogt` line 6396</sub>
 
 ## Column kinds
 
@@ -419,4 +423,4 @@ column TilemapAsset {
 }
 ```
 
-<sub>`api.ogt` line 6272</sub>
+<sub>`api.ogt` line 6302</sub>

package/knowledge/wiki/time.md

@@ -14,7 +14,7 @@ module time {
   # declarations follow, each quoted below
 ```
 
-<sub>`api.ogt` line 582</sub>
+<sub>`api.ogt` line 593</sub>
 
 ## Contents
 
@@ -54,7 +54,7 @@ fn setScale {
 }
 ```
 
-<sub>`api.ogt` line 624</sub>
+<sub>`api.ogt` line 635</sub>
 
 <a id="fn-hitStop"></a>
 
@@ -84,7 +84,7 @@ fn hitStop {
 }
 ```
 
-<sub>`api.ogt` line 631</sub>
+<sub>`api.ogt` line 642</sub>
 
 ## Components, resources and events
 
@@ -147,4 +147,4 @@ resource Time {
 }
 ```
 
-<sub>`api.ogt` line 586</sub>
+<sub>`api.ogt` line 597</sub>