From 30033ae20d569c51b4481855f0407cbf1f03c65f Mon Sep 17 00:00:00 2001 From: Gene Pasquet Date: Mon, 20 Apr 2026 13:47:18 +0100 Subject: Documentation improvements --- docs/tweens.org | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'docs/tweens.org') diff --git a/docs/tweens.org b/docs/tweens.org index 063a485..f63a9e1 100644 --- a/docs/tweens.org +++ b/docs/tweens.org @@ -36,7 +36,7 @@ key that isn't on the entity yet starts from zero. ** Creating a tween -=make-tween= signature (from [[file:../tween.scm][tween.scm]]): +=make-tween= signature (from [[https://git.etenil.net/downstroke/tree/tween.scm][tween.scm]]): #+BEGIN_SRC scheme (make-tween entity #!key @@ -86,7 +86,7 @@ error immediately from =make-tween=. Attach a tween by storing it under =#:tween= on an entity. The engine's default update pipeline runs =step-tweens= as its first per-entity -step (see [[file:../engine.scm][engine.scm]], =default-engine-update=): +step (see [[https://git.etenil.net/downstroke/tree/engine.scm][engine.scm]], =default-engine-update=): #+BEGIN_SRC scheme (chain scene @@ -115,7 +115,7 @@ step (see [[file:../engine.scm][engine.scm]], =default-engine-update=): backward. The "clear to =#f=" behaviour is hard-coded in =step-tweens= (see -[[file:../tween.scm][tween.scm]]): +[[https://git.etenil.net/downstroke/tree/tween.scm][tween.scm]]): #+BEGIN_SRC scheme (if (tween-finished? tw2) @@ -134,7 +134,7 @@ tween (=repeat: -1=), =on-complete= never fires. The ease symbol you pass to =make-tween= is looked up in =*ease-table*= and resolved to a procedure. The full table, copied from -[[file:../tween.scm][tween.scm]]: +[[https://git.etenil.net/downstroke/tree/tween.scm][tween.scm]]: | symbol | shape | |---------------+---------------------------------------------| @@ -244,7 +244,7 @@ entity. The callback is invoked with the entity in its /final/ interpolated state. The signature is just =(lambda (entity) ...)= and — importantly — its return value is /discarded/. Look at =tween-complete= in -[[file:../tween.scm][tween.scm]]: the callback runs for side-effects +[[https://git.etenil.net/downstroke/tree/tween.scm][tween.scm]]: the callback runs for side-effects only, and the entity returned to the pipeline is the unmodified =final=. So =on-complete= is for triggering world-level actions (playing a sound, logging, enqueueing a command, mutating a global -- cgit v1.2.3