37 lines
No EOL
2.4 KiB
HTML
37 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>Tween.progress — Ludic</title>
|
||
<meta name="description" content="A one-shot 0..1 amount, clamped, for timer over duration.">
|
||
<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-tween.html">Tween</a> <span>›</span> <span class="here">Tween.progress</span></div>
|
||
<div class="item-head">
|
||
<span class="kind-badge kind-method">method</span>
|
||
<h1 id="top">Tween.progress</h1>
|
||
</div>
|
||
<code class="sig">Tween.progress(timer, duration) -> fixed</code>
|
||
<div class="desc"><p>Returns <code>timer / duration</code> clamped to <code>0.0</code>..<code>1.0</code> — the normalized progress of a one-shot tween. Feed it to <a href="tween-ease"><code>Tween.ease</code></a> to shape it, then to a typed blend. Once <code>timer</code> reaches <code>duration</code> it pins at <code>1.0</code> (a non-positive <code>duration</code> also reads as done).</p></div>
|
||
<div class="params"><h2>Parameters</h2><div class="param" id="param-timer"><code class="pname">timer</code><span class="pdesc">elapsed seconds (a <code>fixed</code>)</span></div><div class="param" id="param-duration"><code class="pname">duration</code><span class="pdesc">the tween's length in seconds (a <code>fixed</code>)</span></div></div>
|
||
<div class="examples"><h2>Example</h2><pre data-lang="ludic">program Demo {
|
||
property Fade { timer: fixed = 0.0 }
|
||
model Panel { Fade }
|
||
handler Run phase Update {
|
||
Fade.timer = Fade.timer + Time.delta()
|
||
let t = Tween.progress(Fade.timer, fixed(1))
|
||
let a = Tween.round(0, 255, Tween.ease(t, 2))
|
||
print(a)
|
||
}
|
||
}</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> |