40 lines
No EOL
2.6 KiB
HTML
40 lines
No EOL
2.6 KiB
HTML
<!doctype html>
|
||
<html lang="en">
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
<title>world_prop_id — Ludic</title>
|
||
<meta name="description" content="Resolve a property's name to its stable numeric 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 & the ECS</a> <span>›</span> <span class="here">world_prop_id</span></div>
|
||
<div class="item-head">
|
||
<span class="kind-badge kind-builtin">function</span>
|
||
<h1 id="top">world_prop_id</h1>
|
||
</div>
|
||
<code class="sig">world_prop_id(name) -> int</code>
|
||
<div class="desc"><p><code>world_prop_id</code> resolves a property by name to its stable numeric id, returning a negative value when no such property exists. It is the entry point to the reflection ABI's field access: pass the returned property id to <code>world_has</code>, <code>world_count</code>, <code>world_get</code>/<code>world_set</code> (together with a field id from <code>world_field_id</code>), and the dynamic attach/detach and query calls. Resolve the id once and cache it in a <code>var</code> rather than looking it up every frame. This id-based view complements the static <code>query [...]</code>, which is how ordinary handlers reach properties by name.</p></div>
|
||
<div class="params"><h2>Parameters</h2><div class="param" id="param-name"><code class="pname">name</code><span class="pdesc">the property's name, as a string, e.g. <code>"Position"</code></span></div></div>
|
||
<div class="examples"><h2>Example</h2><pre data-lang="ludic">program ResolveProperty {
|
||
property Position { column: int = 0, row: int = 0 }
|
||
model Player { Position }
|
||
|
||
handler Boot phase Start {
|
||
spawn Hero { Position { column: 3, row: 3 } }
|
||
}
|
||
|
||
handler Inspect phase Update {
|
||
let position_property = world_prop_id("Position")
|
||
Screen.status(string(position_property))
|
||
}
|
||
}</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> |