43 lines
No EOL
2.7 KiB
HTML
43 lines
No EOL
2.7 KiB
HTML
<!doctype html>
|
||
<html lang="en">
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
<title>enable — Ludic</title>
|
||
<meta name="description" content="Re-activate a disabled property, model, or handler — its data is intact.">
|
||
<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">enable</span></div>
|
||
<div class="item-head">
|
||
<span class="kind-badge kind-keyword">keyword</span>
|
||
<h1 id="top">enable</h1>
|
||
</div>
|
||
<code class="sig">enable Prop on entity</code>
|
||
<div class="desc"><p><code>enable</code> reverses a <code>disable</code>: it turns something back on without recreating it. <code>enable Prop on instance</code> restores a property's has-flag so queries match the instance again, with the field values exactly as they were left — nothing was copied or freed, so re-enabling is cheap and lossless. There are three scopes, matching <code>disable</code>: a single property on one instance (<code>enable Shield on self()</code>), a whole model (<code>enable Enemy</code>, all its instances rejoin every query), and a handler (<code>enable AiThink</code>, it resumes running each phase). Re-enabling a property fires any <code>@OnEnable(Prop)</code> hook at the toggle point. Reach for enable/disable when you want to pause and resume, and for <code>attach</code>/<code>detach</code> when you want to add or structurally remove.</p></div>
|
||
|
||
<div class="examples"><h2>Example</h2><pre data-lang="ludic">program ShieldToggle {
|
||
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: 8, row: 8 }; Shield { amount: 3 } }
|
||
disable Shield on self()
|
||
}
|
||
|
||
handler RestoreShield phase Update {
|
||
if Input.key() == ' ' {
|
||
for (position) in query [Position, {Player}] { enable 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> |