ludic/docs/language/networking/fn-serialize.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.7 KiB

id name category kind tokens sig tip order
fn-serialize serialize networking builtin serialize serialize(target, buf) -> int Pack a model instance's @Sync fields into a buffer; returns bytes written. 50

serialize writes the replicated state of a model instance into buf and returns how many bytes it wrote. It is compiler-generated from the schema: it copies exactly the fields that are both @Sync-marked and participating in that instance's model, tightly packed in member-then-field order, and nothing else. This is the dispatcher over the per-model codecs, so it works for any spawned model whose fields sync. Use it to snapshot state before shipping it with net_send or before a rollback; the inverse is apply, which reads back the identical layout, and sync_size gives the byte count up front so you can size a buffer.

Parameters:

  • target — the model instance (an entity) whose synced fields are read
  • buf — the destination buffer the packed bytes are written into
program SnapshotPlayer {
  @Sync property Position { column: int = 0, row: int = 0 }
  property Health { @Sync current: int = 0, maximum: int = 0 }
  @Owned model Player { @Sync Position, @Sync Health }

  entry {
    spawn Player { Position { column: 3, row: 4 }, Health { current: 50, maximum: 100 } }
    for (Position, Health) in query [Position, Health, {Player}] {
      let player_id = self()
      let snapshot_buffer = bytes(64)
      let byte_count = serialize(player_id, snapshot_buffer)     # pack column, row, current
      print(byte_count)                                          # 12 = Position(8) + Health.current(4)
    }
  }
}