43 lines
No EOL
2.6 KiB
HTML
43 lines
No EOL
2.6 KiB
HTML
<!doctype html>
|
||
<html lang="en">
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
<title>world_save — Ludic</title>
|
||
<meta name="description" content="Serialize the whole world into a buffer; returns the number of bytes written.">
|
||
<link rel="stylesheet" href="base.css">
|
||
<link rel="stylesheet" href="docs.css">
|
||
</head>
|
||
<body>
|
||
<header class="nav"><div class="wrap nav-in"><a class="brand" href="index.html"><span class="logo">L</span> Ludic</a><button class="nav-toggle" aria-label="Toggle menu" aria-expanded="false">☰</button><nav class="nav-links"><a href="index.html">Home</a><a href="api.html">API Reference</a><a class="nav-cta" href="https://git.workshopsoft.io/workshopsoft/ludic">Source ↗</a></nav></div></header>
|
||
<main class="wrap item">
|
||
<div class="crumbs"><a href="api.html">API Reference</a> <span>›</span> <a href="api.html#ecs">Entities & the ECS</a> <span>›</span> <span class="here">world_save</span></div>
|
||
<div class="item-head">
|
||
<span class="kind-badge kind-builtin">function</span>
|
||
<h1 id="top">world_save</h1>
|
||
</div>
|
||
<code class="sig">world_save(buf) -> int</code>
|
||
<div class="desc"><p><code>world_save</code> serializes the entire ECS world — every live instance, its kind, and all its property fields — into a byte buffer you provide, and returns the number of bytes written. It is the low-level, buffer-based form of a save: allocate a buffer with <code>bytes(n)</code> large enough to hold the snapshot, pass it in, and persist the written bytes (or hand them across the mod ABI). The exact count comes back so you know how much of the buffer is meaningful. Restore a snapshot later with <code>world_load</code>. For a simple whole-game save to the default slot, the higher-level <code>save()</code> builtin is usually enough.</p></div>
|
||
<div class="params"><h2>Parameters</h2><div class="param" id="param-buf"><code class="pname">buf</code><span class="pdesc">the destination byte buffer, e.g. from <code>bytes(n)</code></span></div></div>
|
||
<div class="examples"><h2>Example</h2><pre data-lang="ludic">program SnapshotOut {
|
||
property Position { column: int = 0, row: int = 0 }
|
||
model Enemy { Position }
|
||
|
||
handler Boot phase Start {
|
||
spawn Grunt { Position { column: 3, row: 3 } }
|
||
}
|
||
|
||
handler Persist phase Update {
|
||
if Input.key() == 's' {
|
||
let buffer = bytes(4096)
|
||
let written = world_save(buffer)
|
||
Screen.status(string(written))
|
||
}
|
||
}
|
||
}</pre></div>
|
||
|
||
<a class="back" href="api.html">← All symbols</a>
|
||
</main>
|
||
<script src="ludic-highlight.js"></script>
|
||
<script>Ludic.highlightAll(); Ludic.installCards(); Ludic.flashTarget();</script>
|
||
</body></html> |