38 lines
No EOL
2.2 KiB
HTML
38 lines
No EOL
2.2 KiB
HTML
<!doctype html>
|
||
<html lang="en">
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
<title>Query.first — Ludic</title>
|
||
<meta name="description" content="The lowest-id live entity carrying a property, or -1.">
|
||
<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="ns-query.html">Query</a> <span>›</span> <span class="here">Query.first</span></div>
|
||
<div class="item-head">
|
||
<span class="kind-badge kind-method">method</span>
|
||
<h1 id="top">Query.first</h1>
|
||
</div>
|
||
<code class="sig">Query.first(prop) -> int</code>
|
||
<div class="desc"><p>Returns the first (lowest entity id) live entity that carries <code>prop</code>, or <code>-1</code> if none do. Handy for a singleton-ish lookup — the player, the current boss, the one active portal — and to test existence (<code>Query.first(prop) >= 0</code>). Read its fields with <a href="world-get"><code>World.get</code></a>.</p></div>
|
||
<div class="params"><h2>Parameters</h2><div class="param" id="param-prop"><code class="pname">prop</code><span class="pdesc">a property id (from <code>World.prop_id("Name")</code>)</span></div></div>
|
||
<div class="examples"><h2>Example</h2><pre data-lang="ludic">program Demo {
|
||
property Player { hp: int = 0 }
|
||
model Hero { Player }
|
||
entry {
|
||
spawn Hero { Player { hp: 100 } }
|
||
let P = World.prop_id("Player")
|
||
let hp = World.field_id(P, "hp")
|
||
let e = Query.first(P)
|
||
if e >= 0 { print(World.get(e, P, hp)) } # 100
|
||
}
|
||
}</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> |