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>detach — Ludic</title>
|
||
<meta name="description" content="Structurally remove a property from a live model instance.">
|
||
<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">detach</span></div>
|
||
<div class="item-head">
|
||
<span class="kind-badge kind-keyword">keyword</span>
|
||
<h1 id="top">detach</h1>
|
||
</div>
|
||
<code class="sig">detach Prop on entity</code>
|
||
<div class="desc"><p><code>detach</code> removes a property from a live model instance, firing the property's <code>@OnDetach(Prop)</code> hook <b>before</b> the has-flag clears — so the hook can still read the outgoing field values as it tears down. It is the structural opposite of <code>attach</code>: where <code>disable</code> pauses a property but keeps its data for a later <code>enable</code>, <code>detach</code> genuinely removes the property, and a later <code>attach</code> re-seeds fresh fields from defaults. Detaching a property the instance does not have is a no-op. Reach for it when something is gone for good — a shield consumed, a status effect that has run its course, an ability removed.</p></div>
|
||
|
||
<div class="examples"><h2>Example</h2><pre data-lang="ludic">program ShieldBreak {
|
||
property Position { column: int = 0, row: int = 0 }
|
||
property Shield { amount: int = 0 }
|
||
model Player { Position, Shield }
|
||
|
||
handler Boot phase Start {
|
||
spawn Hero { Position { column: 6, row: 6 }; Shield { amount: 1 } }
|
||
}
|
||
|
||
handler ConsumeShield phase Update {
|
||
for (shield) in query [Shield, {Player}] {
|
||
if shield.amount <= 0 { detach Shield on self() }
|
||
}
|
||
}
|
||
}</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> |