workshopsoft/ludic
2
0
Fork 0
Code Issues Pull requests Projects Releases 26 Packages Wiki Activity Actions

docs: regenerate site from f094acfdb5

Browse source
This commit is contained in:
ludic-docs-bot 2026-09-17 22:10:03 +00:00
commit 63c5ed9baf
975 changed files with 55427 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

46
fn-world_query_next.html Normal file
View file

@ -0,0 +1,46 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>world_query_next — Ludic</title>
<meta name="description" content="Step to the next instance carrying a property, walking the world by id.">
<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 &amp; the ECS</a> <span>›</span> <span class="here">world_query_next</span></div>
<div class="item-head">
<span class="kind-badge kind-builtin">function</span>
<h1 id="top">world_query_next</h1>
</div>
<code class="sig">world_query_next(property, cursor) -&gt; entity</code>
<div class="desc"><p><code>world_query_next</code> walks the world by ascending instance id, returning the next live instance at or after the cursor that carries the given property, or a negative value when there are no more. It is the reflection-ABI equivalent of a <code>for (…) in query [Property]</code> loop, expressed as an explicit step so a mod or tool can iterate matching instances by id. Drive it with a loop: start the cursor at <code>0</code>, and after each hit advance the cursor to one past the returned id before calling again. Pass the property id from <code>world_prop_id</code>.</p></div>
<div class="params"><h2>Parameters</h2><div class="param" id="param-property"><code class="pname">property</code><span class="pdesc">the property id to match, from <code>world_prop_id</code></span></div><div class="param" id="param-cursor"><code class="pname">cursor</code><span class="pdesc">the id to start scanning from; advance it past each hit to continue</span></div></div>
<div class="examples"><h2>Example</h2><pre data-lang="ludic">program WalkInstances {
property Position { column: int = 0, row: int = 0 }
model Enemy { Position }
handler Boot phase Start {
spawn GruntA { Position { column: 2, row: 2 } }
spawn GruntB { Position { column: 5, row: 2 } }
}
handler Sweep phase Update {
let position_property = world_prop_id("Position")
var cursor = 0
var found = world_query_next(position_property, cursor)
while found &gt;= 0 {
cursor = found + 1
found = world_query_next(position_property, cursor)
}
}
}</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>