@origingame/engine 0.1.0 → 0.2.0

package/types/bindings.json

@@ -1006,7 +1006,7 @@
         {
           "name": "startTick",
           "column": "u32",
-          "default": 0
+          "default": 4294967295
         },
         {
           "name": "stopTick",
@@ -1837,6 +1837,12 @@
           "column": "bool",
           "default": true
         },
+        {
+          "name": "pushStrength",
+          "column": "f32",
+          "default": 1000,
+          "tunable": true
+        },
         {
           "name": "grounded",
           "column": "bool",
@@ -2061,6 +2067,17 @@
           "column": "f32",
           "default": 0.01
         },
+        {
+          "name": "pushBodies",
+          "column": "bool",
+          "default": true
+        },
+        {
+          "name": "pushStrength",
+          "column": "f32",
+          "default": 1000,
+          "tunable": true
+        },
         {
           "name": "grounded",
           "column": "bool",
@@ -6341,6 +6358,24 @@
   "events": [
     {
       "id": 0,
+      "name": "WorldRestored",
+      "schema": "og.WorldRestored",
+      "module": "world",
+      "fields": [
+        {
+          "name": "from",
+          "type": "u32",
+          "default": 0
+        },
+        {
+          "name": "tick",
+          "type": "u32",
+          "default": 0
+        }
+      ]
+    },
+    {
+      "id": 1,
       "name": "KeyDown",
       "schema": "og.KeyDown",
       "module": "input",
@@ -6363,7 +6398,7 @@
       ]
     },
     {
-      "id": 1,
+      "id": 2,
       "name": "TextInput",
       "schema": "og.TextInput",
       "module": "input",
@@ -6386,7 +6421,7 @@
       ]
     },
     {
-      "id": 2,
+      "id": 3,
       "name": "KeyUp",
       "schema": "og.KeyUp",
       "module": "input",
@@ -6404,7 +6439,7 @@
       ]
     },
     {
-      "id": 3,
+      "id": 4,
       "name": "PointerDown",
       "schema": "og.PointerDown",
       "module": "input",
@@ -6437,7 +6472,7 @@
       ]
     },
     {
-      "id": 4,
+      "id": 5,
       "name": "PointerUp",
       "schema": "og.PointerUp",
       "module": "input",
@@ -6470,7 +6505,7 @@
       ]
     },
     {
-      "id": 5,
+      "id": 6,
       "name": "PointerMove",
       "schema": "og.PointerMove",
       "module": "input",
@@ -6493,7 +6528,7 @@
       ]
     },
     {
-      "id": 6,
+      "id": 7,
       "name": "Wheel",
       "schema": "og.Wheel",
       "module": "input",
@@ -6511,7 +6546,7 @@
       ]
     },
     {
-      "id": 7,
+      "id": 8,
       "name": "A11yAction",
       "schema": "og.A11yAction",
       "module": "input",
@@ -6529,7 +6564,7 @@
       ]
     },
     {
-      "id": 8,
+      "id": 9,
       "name": "AssetReady",
       "schema": "og.AssetReady",
       "module": "load",
@@ -6547,7 +6582,7 @@
       ]
     },
     {
-      "id": 9,
+      "id": 10,
       "name": "AssetFailed",
       "schema": "og.AssetFailed",
       "module": "load",
@@ -6570,7 +6605,7 @@
       ]
     },
     {
-      "id": 10,
+      "id": 11,
       "name": "CollisionStarted",
       "schema": "og.CollisionStarted",
       "module": "physics",
@@ -6606,7 +6641,7 @@
       ]
     },
     {
-      "id": 11,
+      "id": 12,
       "name": "CollisionEnded",
       "schema": "og.CollisionEnded",
       "module": "physics",
@@ -6624,7 +6659,7 @@
       ]
     },
     {
-      "id": 12,
+      "id": 13,
       "name": "SensorEntered",
       "schema": "og.SensorEntered",
       "module": "physics",
@@ -6642,7 +6677,7 @@
       ]
     },
     {
-      "id": 13,
+      "id": 14,
       "name": "SensorExited",
       "schema": "og.SensorExited",
       "module": "physics",
@@ -6660,7 +6695,7 @@
       ]
     },
     {
-      "id": 14,
+      "id": 15,
       "name": "Contact",
       "schema": "og.Contact",
       "module": "physics",
@@ -6683,7 +6718,7 @@
       ]
     },
     {
-      "id": 15,
+      "id": 16,
       "name": "CharacterEvent",
       "schema": "og.CharacterEvent",
       "module": "physics",
@@ -6706,7 +6741,7 @@
       ]
     },
     {
-      "id": 16,
+      "id": 17,
       "name": "Splash",
       "schema": "og.Splash",
       "module": "physics",
@@ -6738,7 +6773,7 @@
       ]
     },
     {
-      "id": 17,
+      "id": 18,
       "name": "AnimationEvent",
       "schema": "og.AnimationEvent",
       "module": "anim",
@@ -6771,7 +6806,7 @@
       ]
     },
     {
-      "id": 18,
+      "id": 19,
       "name": "FlipbookEvent",
       "schema": "og.FlipbookEvent",
       "module": "anim",
@@ -6799,7 +6834,7 @@
       ]
     },
     {
-      "id": 19,
+      "id": 20,
       "name": "TweenCompleted",
       "schema": "og.TweenCompleted",
       "module": "tween",
@@ -6822,7 +6857,7 @@
       ]
     },
     {
-      "id": 20,
+      "id": 21,
       "name": "MusicBeat",
       "schema": "og.MusicBeat",
       "module": "audio",
@@ -6850,7 +6885,7 @@
       ]
     },
     {
-      "id": 21,
+      "id": 22,
       "name": "SoundStarted",
       "schema": "og.SoundStarted",
       "module": "audio",
@@ -6873,7 +6908,7 @@
       ]
     },
     {
-      "id": 22,
+      "id": 23,
       "name": "SoundEnded",
       "schema": "og.SoundEnded",
       "module": "audio",
@@ -6901,7 +6936,7 @@
       ]
     },
     {
-      "id": 23,
+      "id": 24,
       "name": "AiChanged",
       "schema": "og.AiChanged",
       "module": "ai",
@@ -6929,7 +6964,7 @@
       ]
     },
     {
-      "id": 24,
+      "id": 25,
       "name": "PlatformAnswered",
       "schema": "og.PlatformAnswered",
       "module": "platform",
@@ -6947,7 +6982,7 @@
       ]
     },
     {
-      "id": 25,
+      "id": 26,
       "name": "StreamEvent",
       "schema": "og.StreamEvent",
       "module": "stream",

package/types/index.d.ts

@@ -500,6 +500,26 @@ export interface RestoreDesc {
   readonly migrate?: boolean;
 }
 
+/**
+ * A world.restore applied: the tick after it (the first whole tick after a save taken mid-tick, whose next step completes the saved tick) delivers this, read through world.events like any event. Everything in the world came back as saved, request numbers and resources the session filled included; the session did not (og-game §17), so a system that reads this resets what belongs to the session: it forgets requests answered long ago, asks the store again for the settings and progress, and closes a menu the player had open. Sent as that tick starts, not when the restore applies, so the world between the two hashes as the save did.
+ *
+ * The payload of the `WorldRestored` event (token `og.WorldRestored`).
+ */
+export interface WorldRestored {
+  /**
+   * The tick the world was at when the restore applied.
+   *
+   * @unit ticks (fixed simulation steps)
+   */
+  readonly from: number;
+  /**
+   * The saved tick: og.Time's tick right after the restore.
+   *
+   * @unit ticks (fixed simulation steps)
+   */
+  readonly tick: number;
+}
+
 /**
  * Which entities a query matches.
  *
@@ -642,7 +662,7 @@ export interface World {
    */
   snapshot(): Result<string>;
   /**
-   * Replace the world with a save that world.snapshot wrote: entities, components, names, resources, events and the modules' state, so the restored world hashes as the saved one did, on either host. The session stays: input (og.Input, og.Pointers, og.Gamepad), the player's bus volumes (og.Audio), the UI's focus and hover, and what lives outside the world (the platform's calls and clock, the language, the loaded assets, the command channel's scheduled steps, which keep their remaining delays though og.Time takes the saved tick). Called in a system or a command it applies when the tick ends, after the last system; elsewhere (GameDesc.start, between ticks) at once. A save a system took mid-tick restores to that moment of its tick (og.Time reads its tick): the next step completes it (the systems after the saver, then the engine's), so the ticks after it are the saved run's. The meshes and height fields its colliders name must be loaded or registered first (a save naming one that is not is refused). A save holds only the world: progress kept in module variables is not in it, so keep it in components and resources.
+   * Replace the world with a save that world.snapshot wrote: entities, components, names, resources, events and the modules' state, so the restored world hashes as the saved one did, on either host. The session stays: input (og.Input, og.Pointers, og.Gamepad), the player's bus volumes (og.Audio), the UI's focus and hover, and what lives outside the world (the platform's calls and clock, the language, the loaded assets, the command channel's scheduled steps, which keep their remaining delays though og.Time takes the saved tick, so an `og run --commands` script goes on to its last step or `quit` whether the save is of a later tick or an earlier one). Called in a system or a command it applies when the tick ends, after the last system; elsewhere (GameDesc.start, between ticks) at once. Either way the tick after it delivers og.WorldRestored, for the systems that reset what lives in the session. A save a system took mid-tick restores to that moment of its tick (og.Time reads its tick): the next step completes it (the systems after the saver, then the engine's), so the ticks after it are the saved run's. The meshes and height fields its colliders name must be loaded or registered first (a save naming one that is not is refused). A save holds only the world: progress kept in module variables is not in it, so keep it in components and resources.
    *
    * @param save The text world.snapshot returned.
    * @param desc Whether a type whose layout changed since the save is mapped field by field.
@@ -4466,6 +4486,11 @@ export interface Decal {
   visible: boolean;
 }
 
+/**
+ * ParticleSystem.startTick's default: never written. A looping emitter emits as if started at tick 0; a one-shot (`looping false`) emits nothing until its startTick is written, so a burst spawned in `start` waits for its first use. Write it back to re-arm a one-shot without firing it.
+ */
+export declare const PARTICLES_ARMED: 4294967295;
+
 /**
  * Emits particles from an og.load.emitter asset at the entity's MatrixWorld. Particles are simulated by the renderer from (seed, startTick, the tick), so they are deterministic and replay, and never feed back into the simulation: compute on the full tier, the CPU on WebGL2, identical either way.
  *
@@ -4476,7 +4501,11 @@ export interface ParticleSystem {
   emitter: ParticleEmitter;
   /** The random seed: systems with different seeds differ. */
   seed: number;
-  /** The tick emission started: write og.world tick when spawning a one-shot burst. */
+  /**
+   * The tick emission started: write the tick (`time.tick`, `world.tick`) to fire a one-shot burst, or to restart one. Its default, PARTICLES_ARMED, is never written: a looping emitter emits as if started at tick 0, while a one-shot (`looping false`) stays armed and emits nothing until a tick is written, so effects spawned ahead of their first use wait.
+   *
+   * @default 4294967295
+   */
   startTick: number;
   /**
    * The tick emission stops (the particles live out); 0 keeps emitting while the emitter loops.
@@ -6318,7 +6347,7 @@ export interface Joint {
 }
 
 /**
- * A kinematic character (3D, or top-down 2D): the entity's capsule (or any og.Collider) moved by `move` each tick, sliding along walls, climbing slopes up to `maxSlope` and steps up to `stepHeight`, snapped to the ground, carried by the moving platform it stands on and falling by gravity. It keeps `skin` off every surface, standing that far over the ground; a step is climbed when the ground beyond it is at most `stepHeight` over the ground it stands on. What blocks it is every solid collider its og.Collider's `layers` and `mask` interact with (each one's layers meeting the other's mask), as for bodies. The entity needs an og.Transform and an og.Collider; the step makes it a kinematic body and pushes dynamic bodies it walks into.
+ * A kinematic character (3D, or top-down 2D): the entity's capsule (or any og.Collider) moved by `move` each tick, sliding along walls, climbing slopes up to `maxSlope` and steps up to `stepHeight`, snapped to the ground, carried by the moving platform it stands on and falling by gravity. It keeps `skin` off every surface, standing that far over the ground; a step is climbed when the ground beyond it is at most `stepHeight` over the ground it stands on. What blocks it is every solid collider its og.Collider's `layers` and `mask` interact with (each one's layers meeting the other's mask), as for bodies. The entity needs an og.Transform and an og.Collider; the step makes it a kinematic body and pushes the dynamic bodies it walks into (`pushBodies`) with at most `pushStrength`, so a light one is shoved and a heavy one holds.
  *
  * The value of the `CharacterController` component (token `og.CharacterController`).
  */
@@ -6404,11 +6433,20 @@ export interface CharacterController {
    */
   maxFallSpeed: number;
   /**
-   * Push dynamic bodies it walks into.
+   * Push dynamic bodies it walks into, with at most `pushStrength`.
    *
    * @default true
    */
   pushBodies: boolean;
+  /**
+   * The most force it pushes with: each tick the bodies it walks into share an impulse of at most this times the tick's length (mass times the speed it asks of them, capped), so a body of a few kilograms is shoved at its speed while one whose friction holds more (a tonne on the ground) does not move. 0 leaves every body where it is, as `pushBodies` false does.
+   *
+   * @default 1000
+   * @range 0..
+   * @unit newton (newtons: the force that gives a kilogram one metre per second squared)
+   * @tunable
+   */
+  pushStrength: number;
   /**
    * Written: standing on walkable ground after the step.
    *
@@ -6455,7 +6493,7 @@ export interface CharacterController {
 }
 
 /**
- * A 2D platformer character (the 2D profile): run, jump and fall with designer units (jump height and time to apex, not gravity), coyote time, jump buffering, variable jump height (releasing jump while rising cuts the jump), apex hang, air jumps, wall slide and wall jump, one-way platforms (colliders on `oneWayLayers` are solid from above only; hold `down` to drop through), moving platforms (it rides what it stands on) and corner correction (a jump that clips a ceiling corner by less than `cornerCorrection` slides past it). It keeps `skin` off every surface; what blocks it is every solid collider its og.Collider's `layers` and `mask` interact with (each one's layers meeting the other's mask), as for bodies. The entity needs an og.Transform and an og.Collider (a box or capsule); it becomes a kinematic body.
+ * A 2D platformer character (the 2D profile): run, jump and fall with designer units (jump height and time to apex, not gravity), coyote time, jump buffering, variable jump height (releasing jump while rising cuts the jump), apex hang, air jumps, wall slide and wall jump, one-way platforms (colliders on `oneWayLayers` are solid from above only; hold `down` to drop through), moving platforms (it rides what it stands on) and corner correction (a jump that clips a ceiling corner by less than `cornerCorrection` slides past it). It keeps `skin` off every surface; what blocks it is every solid collider its og.Collider's `layers` and `mask` interact with (each one's layers meeting the other's mask), as for bodies. The entity needs an og.Transform and an og.Collider (a box or capsule); it becomes a kinematic body and pushes the dynamic bodies it runs into (`pushBodies`) with at most `pushStrength`, so a crate's mass tells: a light one is shoved at the run speed, a heavy one holds (set its og.RigidBody `mass`).
  *
  * The value of the `PlatformerController` component (token `og.PlatformerController`).
  */
@@ -6674,6 +6712,21 @@ export interface PlatformerController {
    * @unit m (metres)
    */
   skin: number;
+  /**
+   * Push dynamic bodies it runs into, with at most `pushStrength`.
+   *
+   * @default true
+   */
+  pushBodies: boolean;
+  /**
+   * The most force it pushes with: each tick the bodies it runs into share an impulse of at most this times the tick's length (mass times the speed it asks of them, capped), so a body of a few kilograms is shoved at its speed while one whose friction holds more (a tonne on the ground) does not move. 0 leaves every body where it is, as `pushBodies` false does.
+   *
+   * @default 1000
+   * @range 0..
+   * @unit newton (newtons: the force that gives a kilogram one metre per second squared)
+   * @tunable
+   */
+  pushStrength: number;
   /**
    * Written: standing on ground after the step.
    *
@@ -6771,7 +6824,7 @@ export declare const CHARACTER_LEFT_GROUND: 5;
 export declare const CHARACTER_BUMPED: 6;
 
 /**
- * Something a CharacterController or PlatformerController did this step: the hooks for dust, squash, sounds and camera kicks. Read the next tick.
+ * Something a CharacterController or PlatformerController did this step: the hooks for dust, squash, sounds and camera kicks. Read the next tick: the controllers move in the physics step, after the game's systems, so a jump pressed in tick T moves the character in T and its CHARACTER_JUMPED is read in T + 1 (og-feel §12 has the same-tick alternative).
  *
  * The payload of the `CharacterEvent` event (token `og.CharacterEvent`).
  */
@@ -9859,7 +9912,7 @@ export interface Tilemap {
    */
   collision: boolean;
   /**
-   * The collision layers of those colliders, as bits (Collider.layers).
+   * 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
    */
@@ -9887,6 +9940,14 @@ export interface TileLayerInfo {
   readonly parallax: Vector2;
   /** Its solid tiles collide. */
   readonly collision: boolean;
+  /**
+   * The collision layers (og.Collider.layers bits) of its colliders, from its `colliderLayers` line or Tiled int property; 0 (unset) takes Tilemap.colliderLayers.
+   */
+  readonly colliderLayers: number;
+  /**
+   * The layers its colliders collide with (og.Collider.mask bits), from its `colliderMask` line or Tiled int property; 0 (unset) is every layer.
+   */
+  readonly colliderMask: number;
   /**
    * The auto-tiling terrain of a terrain layer (its cells are 1 filled or 0 empty); empty for a tile layer.
    */
@@ -11729,7 +11790,7 @@ export interface PlatformResult {
   /** The tick it was answered at. */
   readonly tick: number;
   /**
-   * The host's clock when it answered, UTC milliseconds since 1970 (PlatformInfo.clock says whose); 0 when the host gave none.
+   * The host's clock when it answered, UTC milliseconds since 1970 (PlatformInfo.clock says whose); 0 when the host gave none. A slot call (saveSlot, loadSlot) answers the time of the store answer that ended it.
    *
    * @unit ms (milliseconds)
    */
@@ -15005,6 +15066,18 @@ export interface PlatformerHudDesc {
    * @default false
    */
   readonly touch?: boolean;
+  /**
+   * The touch Jump button. Every word of the HUD is a field with its English default: a localised game passes its string table's (og.i18n.t).
+   *
+   * @default "Jump"
+   */
+  readonly jumpLabel?: string;
+  /**
+   * The pause button's name (what a screen reader says; the button shows its icon).
+   *
+   * @default "Pause"
+   */
+  readonly pauseLabel?: string;
 }
 
 /** What a HUD answered this tick. */
@@ -15107,6 +15180,24 @@ export interface ShooterHudDesc {
    * @default false
    */
   readonly touch?: boolean;
+  /**
+   * The word after the kill count. Every word of the HUD is a field with its English default: a localised game passes its string table's (og.i18n.t).
+   *
+   * @default "kills"
+   */
+  readonly killsLabel?: string;
+  /**
+   * The touch Fire button.
+   *
+   * @default "Fire"
+   */
+  readonly fireLabel?: string;
+  /**
+   * The pause button's name (what a screen reader says; the button shows its icon).
+   *
+   * @default "Pause"
+   */
+  readonly pauseLabel?: string;
 }
 
 /**
@@ -15151,6 +15242,24 @@ export interface PuzzleHudDesc {
    * @default null
    */
   readonly timeLeft?: number | null;
+  /**
+   * The caption under the moves left. Every word of the HUD is a field with its English default: a localised game passes its string table's (og.i18n.t).
+   *
+   * @default "moves left"
+   */
+  readonly movesLabel?: string;
+  /**
+   * The line beside the stars; `{target}` is replaced by the target, formatted (1,000). A localised game passes its string table's, with `{target}` in it.
+   *
+   * @default "Target {target}"
+   */
+  readonly targetLabel?: string;
+  /**
+   * The pause button's name (what a screen reader says; the button shows its icon).
+   *
+   * @default "Pause"
+   */
+  readonly pauseLabel?: string;
 }
 
 /**
@@ -15266,6 +15375,24 @@ export interface IdleHudDesc {
    * @default "Tap"
    */
   readonly tapLabel?: string;
+  /**
+   * A generator's level badge; `{level}` is replaced by its level. Every word of the HUD is a field with its English default: a localised game passes its string table's (og.i18n.t), with `{level}` in it.
+   *
+   * @default "Lv {level}"
+   */
+  readonly levelLabel?: string;
+  /**
+   * A currency's rate; `{rate}` is replaced by its per-second amount, formatted (+12/s is `+{rate}/s`). A localised game passes its string table's, with `{rate}` in it.
+   *
+   * @default "+{rate}/s"
+   */
+  readonly rateLabel?: string;
+  /**
+   * The pause button's name (what a screen reader says; the button shows its icon).
+   *
+   * @default "Pause"
+   */
+  readonly pauseLabel?: string;
 }
 
 /**
@@ -17711,6 +17838,10 @@ export interface StreamBudget {
  * namespace per module (`og.load`, `og.commands`).
  */
 export declare namespace og {
+  /**
+   * A world.restore applied: the tick after it (the first whole tick after a save taken mid-tick, whose next step completes the saved tick) delivers this, read through world.events like any event. Everything in the world came back as saved, request numbers and resources the session filled included; the session did not (og-game §17), so a system that reads this resets what belongs to the session: it forgets requests answered long ago, asks the store again for the settings and progress, and closes a menu the player had open. Sent as that tick starts, not when the restore applies, so the world between the two hashes as the save did.
+   */
+  const WorldRestored: EventType<WorldRestored>;
   /**
    * Declare the game. The bundle's default export is its result.
    *
@@ -18340,15 +18471,15 @@ export declare namespace og {
    */
   const Joint: ComponentType<{ readonly kind: FieldSpec<"u32">; readonly body: FieldSpec<"Entity">; readonly other: FieldSpec<"Entity">; readonly anchor: FieldSpec<"Vector3">; readonly otherAnchor: FieldSpec<"Vector3">; readonly axis: FieldSpec<"Vector3">; readonly limits: FieldSpec<"bool">; readonly min: FieldSpec<"f32">; readonly max: FieldSpec<"f32">; readonly motor: FieldSpec<"u32">; readonly motorTarget: FieldSpec<"f32">; readonly motorStiffness: FieldSpec<"f32">; readonly motorDamping: FieldSpec<"f32">; readonly motorMaxForce: FieldSpec<"f32">; readonly restLength: FieldSpec<"f32">; readonly stiffness: FieldSpec<"f32">; readonly damping: FieldSpec<"f32">; readonly length: FieldSpec<"f32">; readonly collide: FieldSpec<"bool">; readonly value: FieldSpec<"f32"> }, Joint>;
   /**
-   * A kinematic character (3D, or top-down 2D): the entity's capsule (or any og.Collider) moved by `move` each tick, sliding along walls, climbing slopes up to `maxSlope` and steps up to `stepHeight`, snapped to the ground, carried by the moving platform it stands on and falling by gravity. It keeps `skin` off every surface, standing that far over the ground; a step is climbed when the ground beyond it is at most `stepHeight` over the ground it stands on. What blocks it is every solid collider its og.Collider's `layers` and `mask` interact with (each one's layers meeting the other's mask), as for bodies. The entity needs an og.Transform and an og.Collider; the step makes it a kinematic body and pushes dynamic bodies it walks into.
+   * A kinematic character (3D, or top-down 2D): the entity's capsule (or any og.Collider) moved by `move` each tick, sliding along walls, climbing slopes up to `maxSlope` and steps up to `stepHeight`, snapped to the ground, carried by the moving platform it stands on and falling by gravity. It keeps `skin` off every surface, standing that far over the ground; a step is climbed when the ground beyond it is at most `stepHeight` over the ground it stands on. What blocks it is every solid collider its og.Collider's `layers` and `mask` interact with (each one's layers meeting the other's mask), as for bodies. The entity needs an og.Transform and an og.Collider; the step makes it a kinematic body and pushes the dynamic bodies it walks into (`pushBodies`) with at most `pushStrength`, so a light one is shoved and a heavy one holds.
    */
-  const CharacterController: ComponentType<{ readonly move: FieldSpec<"Vector3">; readonly jump: FieldSpec<"bool">; readonly jumpSpeed: FieldSpec<"f32">; readonly gravityScale: FieldSpec<"f32">; readonly maxSlope: FieldSpec<"f32">; readonly stepHeight: FieldSpec<"f32">; readonly snapDistance: FieldSpec<"f32">; readonly skin: FieldSpec<"f32">; readonly coyoteTime: FieldSpec<"f32">; readonly maxFallSpeed: FieldSpec<"f32">; readonly pushBodies: FieldSpec<"bool">; readonly grounded: FieldSpec<"bool">; readonly sliding: FieldSpec<"bool">; readonly velocity: FieldSpec<"Vector3">; readonly groundNormal: FieldSpec<"Vector3">; readonly coyote: FieldSpec<"f32">; readonly jumpWasHeld: FieldSpec<"bool">; readonly ground: FieldSpec<"Entity"> }, CharacterController>;
+  const CharacterController: ComponentType<{ readonly move: FieldSpec<"Vector3">; readonly jump: FieldSpec<"bool">; readonly jumpSpeed: FieldSpec<"f32">; readonly gravityScale: FieldSpec<"f32">; readonly maxSlope: FieldSpec<"f32">; readonly stepHeight: FieldSpec<"f32">; readonly snapDistance: FieldSpec<"f32">; readonly skin: FieldSpec<"f32">; readonly coyoteTime: FieldSpec<"f32">; readonly maxFallSpeed: FieldSpec<"f32">; readonly pushBodies: FieldSpec<"bool">; readonly pushStrength: FieldSpec<"f32">; readonly grounded: FieldSpec<"bool">; readonly sliding: FieldSpec<"bool">; readonly velocity: FieldSpec<"Vector3">; readonly groundNormal: FieldSpec<"Vector3">; readonly coyote: FieldSpec<"f32">; readonly jumpWasHeld: FieldSpec<"bool">; readonly ground: FieldSpec<"Entity"> }, CharacterController>;
   /**
-   * A 2D platformer character (the 2D profile): run, jump and fall with designer units (jump height and time to apex, not gravity), coyote time, jump buffering, variable jump height (releasing jump while rising cuts the jump), apex hang, air jumps, wall slide and wall jump, one-way platforms (colliders on `oneWayLayers` are solid from above only; hold `down` to drop through), moving platforms (it rides what it stands on) and corner correction (a jump that clips a ceiling corner by less than `cornerCorrection` slides past it). It keeps `skin` off every surface; what blocks it is every solid collider its og.Collider's `layers` and `mask` interact with (each one's layers meeting the other's mask), as for bodies. The entity needs an og.Transform and an og.Collider (a box or capsule); it becomes a kinematic body.
+   * A 2D platformer character (the 2D profile): run, jump and fall with designer units (jump height and time to apex, not gravity), coyote time, jump buffering, variable jump height (releasing jump while rising cuts the jump), apex hang, air jumps, wall slide and wall jump, one-way platforms (colliders on `oneWayLayers` are solid from above only; hold `down` to drop through), moving platforms (it rides what it stands on) and corner correction (a jump that clips a ceiling corner by less than `cornerCorrection` slides past it). It keeps `skin` off every surface; what blocks it is every solid collider its og.Collider's `layers` and `mask` interact with (each one's layers meeting the other's mask), as for bodies. The entity needs an og.Transform and an og.Collider (a box or capsule); it becomes a kinematic body and pushes the dynamic bodies it runs into (`pushBodies`) with at most `pushStrength`, so a crate's mass tells: a light one is shoved at the run speed, a heavy one holds (set its og.RigidBody `mass`).
    */
-  const PlatformerController: ComponentType<{ readonly moveX: FieldSpec<"f32">; readonly jump: FieldSpec<"bool">; readonly down: FieldSpec<"bool">; readonly impulse: FieldSpec<"Vector2">; readonly maxSpeed: FieldSpec<"f32">; readonly acceleration: FieldSpec<"f32">; readonly deceleration: FieldSpec<"f32">; readonly airAcceleration: FieldSpec<"f32">; readonly airDeceleration: FieldSpec<"f32">; readonly jumpHeight: FieldSpec<"f32">; readonly timeToApex: FieldSpec<"f32">; readonly fallGravity: FieldSpec<"f32">; readonly jumpCut: FieldSpec<"f32">; readonly apexGravity: FieldSpec<"f32">; readonly apexThreshold: FieldSpec<"f32">; readonly maxFallSpeed: FieldSpec<"f32">; readonly coyoteTime: FieldSpec<"f32">; readonly jumpBuffer: FieldSpec<"f32">; readonly airJumps: FieldSpec<"u32">; readonly wallJumps: FieldSpec<"bool">; readonly wallSlideSpeed: FieldSpec<"f32">; readonly wallJump: FieldSpec<"Vector2">; readonly wallJumpLock: FieldSpec<"f32">; readonly oneWayLayers: FieldSpec<"u32">; readonly cornerCorrection: FieldSpec<"f32">; readonly maxSlope: FieldSpec<"f32">; readonly snapDistance: FieldSpec<"f32">; readonly skin: FieldSpec<"f32">; readonly grounded: FieldSpec<"bool">; readonly onWall: FieldSpec<"i32">; readonly facing: FieldSpec<"i32">; readonly velocity: FieldSpec<"Vector3">; readonly jumping: FieldSpec<"bool">; readonly airJumpsLeft: FieldSpec<"u32">; readonly coyote: FieldSpec<"f32">; readonly buffer: FieldSpec<"f32">; readonly wallLock: FieldSpec<"f32">; readonly dropTime: FieldSpec<"f32">; readonly jumpWasHeld: FieldSpec<"bool">; readonly ground: FieldSpec<"Entity"> }, PlatformerController>;
+  const PlatformerController: ComponentType<{ readonly moveX: FieldSpec<"f32">; readonly jump: FieldSpec<"bool">; readonly down: FieldSpec<"bool">; readonly impulse: FieldSpec<"Vector2">; readonly maxSpeed: FieldSpec<"f32">; readonly acceleration: FieldSpec<"f32">; readonly deceleration: FieldSpec<"f32">; readonly airAcceleration: FieldSpec<"f32">; readonly airDeceleration: FieldSpec<"f32">; readonly jumpHeight: FieldSpec<"f32">; readonly timeToApex: FieldSpec<"f32">; readonly fallGravity: FieldSpec<"f32">; readonly jumpCut: FieldSpec<"f32">; readonly apexGravity: FieldSpec<"f32">; readonly apexThreshold: FieldSpec<"f32">; readonly maxFallSpeed: FieldSpec<"f32">; readonly coyoteTime: FieldSpec<"f32">; readonly jumpBuffer: FieldSpec<"f32">; readonly airJumps: FieldSpec<"u32">; readonly wallJumps: FieldSpec<"bool">; readonly wallSlideSpeed: FieldSpec<"f32">; readonly wallJump: FieldSpec<"Vector2">; readonly wallJumpLock: FieldSpec<"f32">; readonly oneWayLayers: FieldSpec<"u32">; readonly cornerCorrection: FieldSpec<"f32">; readonly maxSlope: FieldSpec<"f32">; readonly snapDistance: FieldSpec<"f32">; readonly skin: FieldSpec<"f32">; readonly pushBodies: FieldSpec<"bool">; readonly pushStrength: FieldSpec<"f32">; readonly grounded: FieldSpec<"bool">; readonly onWall: FieldSpec<"i32">; readonly facing: FieldSpec<"i32">; readonly velocity: FieldSpec<"Vector3">; readonly jumping: FieldSpec<"bool">; readonly airJumpsLeft: FieldSpec<"u32">; readonly coyote: FieldSpec<"f32">; readonly buffer: FieldSpec<"f32">; readonly wallLock: FieldSpec<"f32">; readonly dropTime: FieldSpec<"f32">; readonly jumpWasHeld: FieldSpec<"bool">; readonly ground: FieldSpec<"Entity"> }, PlatformerController>;
   /**
-   * Something a CharacterController or PlatformerController did this step: the hooks for dust, squash, sounds and camera kicks. Read the next tick.
+   * Something a CharacterController or PlatformerController did this step: the hooks for dust, squash, sounds and camera kicks. Read the next tick: the controllers move in the physics step, after the game's systems, so a jump pressed in tick T moves the character in T and its CHARACTER_JUMPED is read in T + 1 (og-feel §12 has the same-tick alternative).
    */
   const CharacterEvent: EventType<CharacterEvent>;
   /**