ludic/docs/language/ecs/fn-world_load.md
Orkuncakilkaya 3c7ec9b016
All checks were successful
docs / build-and-deploy (push) Successful in 2s
docs(api): per-symbol pages, fuzzy search, deep token linking, hover cards
Rebuild the API Reference around one page per symbol and richer, verified content.

Pages & navigation
- One HTML page per symbol (kw-*, type-*, phase-*, screen-*, fn-*, annot-*, op-*)
  instead of a single scrolling page; namespace overview pages (ns-screen …
  ns-color) and a searchable index (api.html) with client-side fuzzy search.
- Sticky-header scroll offset (scroll-margin) so a jumped-to entry/param/color is
  never hidden, plus a flash highlight on the scrolled-to target.

Deep linking in every snippet & example
- Namespace members split: `Screen`→namespace page, `fill_rectangle`→method page;
  `Color`→palette page, `Charcoal`→its swatch — separately.
- Named arguments (`width:`) link to that parameter's anchor on the method page.
- Hover any token for a summary card built from the real API data (symbols.json).

Content & coverage
- Full authoritative surface documented from the compiler: every keyword, type,
  the 6 phases (Start/Input/FixedUpdate/Update/LateUpdate/Render, each its own
  page), all 22 annotations, namespace methods with parameter docs, builtins,
  the world_* reflection ABI, networking, operators — 155 symbols.
- Longer, clearer explanations; "model"/"model instance" terminology, not "entity";
  descriptive identifiers in every example (Position{column,row}, Velocity{delta_x,
  delta_y}, Health{current,maximum}, Player/Enemy) — no Pos/Seg/x/dx.
- Accuracy fixes from compiler ground-truth: world_count() takes no arg,
  world_query_next(property, cursor) arg order, event fields bind by name; dropped
  `when` and `module` (not in the self-hosted parser).

Tooling
- inventory.json + check.py: coverage guard (every symbol has a page), duplicate-
  token guard, and broken-link guard — fail CI so docs can't drift.
- validate.py: compiles every ```ludic example against bin/ludicc (158 compile).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-08-29 17:53:22 +03:00

1.3 KiB

id name category kind tokens sig tip order
fn-world_load world_load ecs builtin world_load world_load(buf, len) Restore the whole world from a serialized byte buffer. 50

world_load restores the ECS world from a byte buffer previously produced by world_save, replacing the current world with the snapshot's instances and their fields. You pass the buffer and the number of valid bytes in it (the count world_save returned), and the world is rebuilt in place; it returns nothing. This is the low-level, buffer-based counterpart of world_save — the pair a mod or tool uses to move a whole world across the ABI or between storage. For a simple whole-game load from the default slot, the higher-level load() builtin is usually enough.

Parameters:

  • buf — the source byte buffer holding a snapshot
  • len — the number of valid bytes in buf
program SnapshotRoundTrip {
  property Position { column: int = 0, row: int = 0 }
  model Enemy { Position }

  var snapshot_length: int = 0

  handler Boot phase Start {
    spawn Grunt { Position { column: 3, row: 3 } }
  }

  handler RoundTrip phase Update {
    let buffer = bytes(4096)
    if Input.key() == 's' { snapshot_length = world_save(buffer) }
    if Input.key() == 'l' { world_load(buffer, snapshot_length) }
  }
}