42 lines
No EOL
2.5 KiB
HTML
42 lines
No EOL
2.5 KiB
HTML
<!doctype html>
|
||
<html lang="en">
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
<title>@Writes — Ludic</title>
|
||
<meta name="description" content="Declare that a handler writes a property — an analysis and scheduling hint.">
|
||
<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#annotations">Annotations</a> <span>›</span> <span class="here">@Writes</span></div>
|
||
<div class="item-head">
|
||
<span class="kind-badge kind-annotation">annotation</span>
|
||
<h1 id="top">@Writes</h1>
|
||
</div>
|
||
<code class="sig">@Writes(Property)</code>
|
||
<div class="desc"><p><code>@Writes(Property)</code> declares that a handler writes the named property. Like <code>@Reads</code> it is an analysis hint that documents a handler's data footprint so tooling and scheduling can reason about conflicts — two handlers that write the same property, or one that writes what another reads, cannot be reordered freely. It does not bind fields or grant access on its own; the handler still queries and mutates the property in its body as usual. Declaring reads and writes together makes a handler's effect on the world legible at a glance, which matters most in a large, modular codebase. Keep the named property accurate so the declared footprint matches the code.</p></div>
|
||
|
||
<div class="examples"><h2>Example</h2><pre data-lang="ludic">program WriteFootprint {
|
||
property Health { current: int = 100 }
|
||
model Enemy { Health }
|
||
|
||
@Reads(Health) @Writes(Health) # full read/write footprint
|
||
handler ApplyPoison phase Update {
|
||
for (Health) in query [Health, {Enemy}] {
|
||
Health.current = Health.current - 1
|
||
}
|
||
}
|
||
|
||
handler SpawnEnemy phase Start {
|
||
spawn Enemy { Health { current: 100 } }
|
||
}
|
||
}</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> |