42 lines
No EOL
2.4 KiB
HTML
42 lines
No EOL
2.4 KiB
HTML
<!doctype html>
|
||
<html lang="en">
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
<title>self — Ludic</title>
|
||
<meta name="description" content="The model instance currently bound by the enclosing query loop.">
|
||
<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">self</span></div>
|
||
<div class="item-head">
|
||
<span class="kind-badge kind-keyword">keyword</span>
|
||
<h1 id="top">self</h1>
|
||
</div>
|
||
<code class="sig">self()</code>
|
||
<div class="desc"><p><code>self()</code> yields the model instance currently being visited by the innermost enclosing <code>query</code> loop, as an <code>entity</code> handle. It is how a handler names "the instance this pass is about" — most often to <code>despawn self()</code>, to <code>attach</code>/<code>detach</code> a property <code>on self()</code>, or to pass the current instance to a function. Because it depends on the active query iteration, <code>self()</code> is only meaningful inside a <code>for (…) in query […]</code> loop (or a <code>@Queries</code> handler, which desugars to one). Outside any query it has no instance to refer to.</p></div>
|
||
|
||
<div class="examples"><h2>Example</h2><pre data-lang="ludic">program Reaper {
|
||
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: 1, row: 1 }; 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> |