44 lines
No EOL
2.5 KiB
HTML
44 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>attach — Ludic</title>
|
||
<meta name="description" content="Structurally add a property to a live model instance, seeding its fields.">
|
||
<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">attach</span></div>
|
||
<div class="item-head">
|
||
<span class="kind-badge kind-keyword">keyword</span>
|
||
<h1 id="top">attach</h1>
|
||
</div>
|
||
<code class="sig">attach Prop on entity { overrides }</code>
|
||
<div class="desc"><p><code>attach</code> adds a property to a live model instance that did not have it, seeding the fields from their defaults plus any overrides in the <code>{ … }</code> block, and fires the property's <code>@OnAttach(Prop)</code> hook. It is a <b>structural</b> change — it changes what the instance <i>has</i> — as opposed to <code>enable</code>, which merely resumes a property the instance already carries. Attaching a property the instance already has is a no-op, so the hook only runs on a real transition. Use it to grant something new at runtime: give a player a shield pickup, tag an enemy as enraged, or add a component only some instances need.</p></div>
|
||
|
||
<div class="examples"><h2>Example</h2><pre data-lang="ludic">program Pickups {
|
||
property Position { column: int = 0, row: int = 0 }
|
||
property Shield { amount: int = 0 }
|
||
model Player { Position }
|
||
|
||
handler Boot phase Start {
|
||
spawn Hero { Position { column: 6, row: 6 } }
|
||
}
|
||
|
||
handler GrabShield phase Update {
|
||
if Input.key() == ' ' {
|
||
for (position) in query [Position, {Player}] {
|
||
attach Shield on self() { amount: 3 }
|
||
}
|
||
}
|
||
}
|
||
}</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> |