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>despawn — Ludic</title>
|
||
<meta name="description" content="Remove a model instance from the world, firing any @OnDespawn hooks.">
|
||
<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">despawn</span></div>
|
||
<div class="item-head">
|
||
<span class="kind-badge kind-keyword">keyword</span>
|
||
<h1 id="top">despawn</h1>
|
||
</div>
|
||
<code class="sig">despawn entity</code>
|
||
<div class="desc"><p>A <code>despawn</code> removes a model instance from the world, freeing its slot and firing any <code>@OnDespawn</code> lifecycle hooks for its kind. The most common form is <code>despawn self()</code> inside a query loop, which removes the instance currently being visited. Because queries iterate lazily by ascending id rather than from a frozen snapshot, despawning the current instance — or one already visited — is safe and will not disturb the walk. Despawning is how the moving parts of a game leave: an enemy that reached zero health, a projectile that flew off screen, or every instance of a kind during a reset.</p></div>
|
||
|
||
<div class="examples"><h2>Example</h2><pre data-lang="ludic">program Cleanup {
|
||
property Position { column: int = 0, row: int = 0 }
|
||
property Health { current: int = 100, maximum: int = 100 }
|
||
model Enemy { Position, Health }
|
||
|
||
handler Boot phase Start {
|
||
spawn Grunt { Position { column: 3, row: 3 }; Health { current: 0 } }
|
||
}
|
||
|
||
handler RemoveDefeated phase LateUpdate {
|
||
for (health) in query [Health, {Enemy}] {
|
||
if health.current <= 0 { despawn 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> |