@origingame/engine 0.4.0 → 0.5.0

package/knowledge/wiki/reflect.md

@@ -8,7 +8,7 @@ The inspector, Tune, the probe, scene text and the wiki read this one schema. Ea
 
 A field holds one value, or a list of at most a fixed number of one number type or handle: `list(u32(), 8)`, `list(Asset(), 4)` (the list factory below). A list is read as a frozen copy (`push` throws) and written whole (`chain.passes = [...chain.passes, h]`); one over its capacity is refused, never truncated. A few vectors are numbered fields (`p0` to `p7`, as og.CameraRail does); a list of things with fields of their own is an entity each, with its own component, looped over by a query (a ring of skid marks, the laps of a race); a long record (a lap's taped inputs) is text in `str` fields of at most 4,096 bytes each, chunked over entities. Keep none of it in module variables: they are not world state, so a snapshot, a replay and a hot reload lose them.
 
-A handle (an og.load answer, a texture, a sound, a geometry, a material, an entity) is a 64-bit number: keep it in a field of its own kind (`Asset()`, `Texture()`, `Sound()`, `Geometry()`, `Material()`, `Entity()`, the factories of the API's handle types), in a component or a resource. A `u32` field refuses one (handles pass 2^32: `4294967298 is not a u32`); an `f64` holds the number but loses its type.
+A handle (an og.load answer, a texture, a sound, a geometry, a material, an entity) is a 64-bit number: keep it in a field of its own kind (`Asset()`, `Texture()`, `Sound()`, `Font()`, `Style()`, `Geometry()`, `Material()`, `Entity()`: every handle type of the API has its factory, named as the type), never cast to another kind, in a component or a resource. A `u32` field refuses one (handles pass 2^32: `4294967298 is not a u32`); an `f64` holds the number but loses its type.
 
 - **TypeScript**: functions are named exports of the package: `import { … } from "@origingame/engine"`; components, resources and events are tokens on `og`.
 - **Publish builds**: kept (members may override).
@@ -20,7 +20,7 @@ module reflect {
   # declarations follow, each quoted below
 ```
 
-<sub>`api.ogt` line 660</sub>
+<sub>`api.ogt` line 661</sub>
 
 ## Contents
 
@@ -76,7 +76,7 @@ fn defineComponent {
 }
 ```
 
-<sub>`api.ogt` line 764</sub>
+<sub>`api.ogt` line 765</sub>
 
 <a id="fn-defineResource"></a>
 
@@ -107,7 +107,7 @@ fn defineResource {
 }
 ```
 
-<sub>`api.ogt` line 773</sub>
+<sub>`api.ogt` line 774</sub>
 
 ## Types
 
@@ -143,7 +143,7 @@ struct FieldOptions {
 }
 ```
 
-<sub>`api.ogt` line 668</sub>
+<sub>`api.ogt` line 669</sub>
 
 ## Column kinds
 
@@ -173,7 +173,7 @@ column f32 {
 }
 ```
 
-<sub>`api.ogt` line 680</sub>
+<sub>`api.ogt` line 681</sub>
 
 ```ogt
 column f64 {
@@ -184,7 +184,7 @@ column f64 {
 }
 ```
 
-<sub>`api.ogt` line 687</sub>
+<sub>`api.ogt` line 688</sub>
 
 ```ogt
 column u32 {
@@ -195,7 +195,7 @@ column u32 {
 }
 ```
 
-<sub>`api.ogt` line 694</sub>
+<sub>`api.ogt` line 695</sub>
 
 ```ogt
 column i32 {
@@ -206,7 +206,7 @@ column i32 {
 }
 ```
 
-<sub>`api.ogt` line 701</sub>
+<sub>`api.ogt` line 702</sub>
 
 ```ogt
 column bool {
@@ -217,7 +217,7 @@ column bool {
 }
 ```
 
-<sub>`api.ogt` line 708</sub>
+<sub>`api.ogt` line 709</sub>
 
 ```ogt
 column Vector2 {
@@ -228,7 +228,7 @@ column Vector2 {
 }
 ```
 
-<sub>`api.ogt` line 715</sub>
+<sub>`api.ogt` line 716</sub>
 
 ```ogt
 column Vector3 {
@@ -239,7 +239,7 @@ column Vector3 {
 }
 ```
 
-<sub>`api.ogt` line 722</sub>
+<sub>`api.ogt` line 723</sub>
 
 ```ogt
 column Quaternion {
@@ -250,7 +250,7 @@ column Quaternion {
 }
 ```
 
-<sub>`api.ogt` line 729</sub>
+<sub>`api.ogt` line 730</sub>
 
 ```ogt
 column Matrix4 {
@@ -261,7 +261,7 @@ column Matrix4 {
 }
 ```
 
-<sub>`api.ogt` line 736</sub>
+<sub>`api.ogt` line 737</sub>
 
 ```ogt
 column Color {
@@ -272,7 +272,7 @@ column Color {
 }
 ```
 
-<sub>`api.ogt` line 743</sub>
+<sub>`api.ogt` line 744</sub>
 
 ```ogt
 column str {
@@ -284,7 +284,7 @@ column str {
 }
 ```
 
-<sub>`api.ogt` line 750</sub>
+<sub>`api.ogt` line 751</sub>
 
 ```ogt
 column list {
@@ -294,4 +294,4 @@ column list {
 }
 ```
 
-<sub>`api.ogt` line 758</sub>
+<sub>`api.ogt` line 759</sub>