47 lines
No EOL
2.5 KiB
HTML
47 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>return — Ludic</title>
|
||
<meta name="description" content="Hand a value back from a function and stop running it.">
|
||
<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#structure">Program structure</a> <span>›</span> <span class="here">return</span></div>
|
||
<div class="item-head">
|
||
<span class="kind-badge kind-keyword">keyword</span>
|
||
<h1 id="top">return</h1>
|
||
</div>
|
||
<code class="sig">return value</code>
|
||
<div class="desc"><p>A <code>return</code> statement ends the current function and hands its result back to the caller. Its value must match the function's declared return type; in a <code>-> void</code> function you write a bare <code>return</code> (or simply let the body end) to exit early. <code>return</code> is often paired with an early guard — check a condition and return straight away — which keeps the common path unindented. Inside a handler's query loop, prefer <code>break</code> or <code>continue</code> to control the loop; <code>return</code> leaves the whole function.</p></div>
|
||
|
||
<div class="examples"><h2>Example</h2><pre data-lang="ludic">program Clamp {
|
||
property Health { current: int = 100, maximum: int = 100 }
|
||
model Player { Health }
|
||
|
||
function clamp_current(value: int, maximum: int) -> int {
|
||
if value < 0 { return 0 }
|
||
if value > maximum { return maximum }
|
||
return value
|
||
}
|
||
|
||
handler Boot phase Start {
|
||
spawn Hero { Health { current: 250, maximum: 100 } }
|
||
}
|
||
|
||
handler Normalize phase Update {
|
||
for (health) in query [Health, {Player}] {
|
||
health.current = clamp_current(value: health.current, maximum: health.maximum)
|
||
}
|
||
}
|
||
}</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> |