zakarya/puzzles
1
0
Fork 0
mirror of git://git.tartarus.org/simon/puzzles.git synced 2025-04-21 08:01:30 -07:00
Code Issues Packages Projects Releases Wiki Activity

Add missing documentation of 'int dir' parameters.

Browse Source 
This integer parameter appears in all of the game's anim_length,
flash_length and redraw methods, but the documentation only described
it properly in the section for anim_length.

The section for flash_length refers you to anim_length for the
description of all the parameters, but unhelpfully, it did so without
a conveniently clickable (in HTML) cross-reference.

And the section for game_redraw missed out the description of 'int
dir' completely, which is particularly unhelpful since that's the
function most likely to actually need to care about it! (Even if
forward and reversed move animations look different, they _probably_
still have the same duration, so it's more likely that anim_length
would ignore 'dir' and redraw would use it than vice versa.)
This commit is contained in:
Simon Tatham
2021-09-13 11:09:54 +01:00
parent 88358f0643
commit 42cbd7688a
1 changed files with 9 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
devel.but
View File

@ -1275,7 +1275,7 @@ activity, so that the victory flash in Net is not cancelled by that
final locking move. final locking move.
The input parameters to \cw{flash_length()} are exactly the same as The input parameters to \cw{flash_length()} are exactly the same as
the ones to \cw{anim_length()}. the ones to \cw{anim_length()}: see \k{backend-anim-length}.
Just like \cw{anim_length()}, when this function is called, it may Just like \cw{anim_length()}, when this function is called, it may
rely on \cw{changed_state()} having been called previously, so if it rely on \cw{changed_state()} having been called previously, so if it
@ -1392,6 +1392,14 @@ that the animation has already been running. If \c{oldstate} is
\cw{NULL}, then \c{anim_time} is unused (and will hopefully be set \cw{NULL}, then \c{anim_time} is unused (and will hopefully be set
to zero to avoid confusion). to zero to avoid confusion).
\c{dir} specifies the chronological order of those states: if it is
positive, then the transition is the result of a move or a redo (and
so \c{newstate} is the later of the two moves), whereas if it is
negative then the transition is the result of an undo (so that
\c{newstate} is the \e{earlier} move). This allows move animations
that are not time-symmetric (such as Inertia, where gems are consumed
during the animation) to be drawn the right way round.
\c{flash_time}, if it is is non-zero, denotes that the game is in \c{flash_time}, if it is is non-zero, denotes that the game is in
the middle of a flash, and gives the time since the start of the the middle of a flash, and gives the time since the start of the
flash. See \k{backend-flash-length} for general discussion of flash. See \k{backend-flash-length} for general discussion of