39 lines
No EOL
2.3 KiB
HTML
39 lines
No EOL
2.3 KiB
HTML
<!doctype html>
|
||
<html lang="en">
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
<title>Tween.value — Ludic</title>
|
||
<meta name="description" content="The current value of a fluent tween handle this frame.">
|
||
<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.value</span></div>
|
||
<div class="item-head">
|
||
<span class="kind-badge kind-method">method</span>
|
||
<h1 id="top">Tween.value</h1>
|
||
</div>
|
||
<code class="sig">Tween.value(handle) -> int</code>
|
||
<div class="desc"><p>Returns the current interpolated value of a <a href="tween-to"><code>tween handle</code></a> this frame — the number the engine advanced it to. Read it each frame to drive a position, an alpha, a scale. Once every segment has finished the value rests on the final target; <a href="tween-done"><code>Tween.done</code></a> reports when that has happened. Returns <code>0</code> for an invalid handle.</p></div>
|
||
<div class="params"><h2>Parameters</h2><div class="param" id="param-handle"><code class="pname">handle</code><span class="pdesc">the tween handle to read</span></div></div>
|
||
<div class="examples"><h2>Example</h2><pre data-lang="ludic">program Demo {
|
||
property Pos { x: int = 0 }
|
||
property Tw { h: int = 0 }
|
||
model Mover { Pos, Tw }
|
||
handler Move phase Update {
|
||
let p = World.prop_id("Pos")
|
||
let t = World.prop_id("Tw")
|
||
let e = World.query_next(t, 0)
|
||
let h = World.get(e, t, World.field_id(t, "h"))
|
||
World.set(e, p, World.field_id(p, "x"), Tween.value(h))
|
||
}
|
||
}</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> |