zakarya/puzzles
1
0
Fork 0
mirror of git://git.tartarus.org/simon/puzzles.git synced 2025-04-20 23:51:29 -07:00
Code Issues Packages Projects Releases Wiki Activity

Add MOVE_NO_EFFECT and MOVE_UNUSED return values from interpret_move()

Browse Source 
These allow for distinguishing the case where a puzzle doesn't have a
use for a key from the case where it just happens to have no effect in
the current state of the puzzle.  These were both represented by NULL,
but that now represents the case where a puzzle hasn't been updated to
make the distinction yet.
This commit is contained in:
Ben Harris
2023-06-04 19:02:21 +01:00
parent a9af3fda1d
commit a943f3177f
4 changed files with 29 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
devel.but
View File

@ -1056,11 +1056,16 @@ puzzle's drawing area.
pointer will be to read the game's tile size parameter in order to
divide mouse coordinates by it.)
\cw{interpret_move()} may return in three different ways:
\cw{interpret_move()} may return in four different ways:
\b Returning \cw{NULL} indicates that no action whatsoever occurred
in response to the input event; the puzzle was not interested in it
at all.
\b Returning \cw{MOVE_UNUSED} or \cw{MOVE_NO_EFFECT} indicates that no
action whatsoever occurred in response to the input event; the puzzle
was not interested in it at all. The distinction between this is that
\cw{MOVE_NO_EFFECT} implies that the state of the game is what makes
the event uninteresting, while \cw{MOVE_NO_EFFECT} means that the
event is intrinsically uninteresting. For example, a mouse click on
an already-revealed square in Mines might return \cw{MOVE_NO_EFFECT}
while a click outside the board would return \cw{MOVE_UNUSED}.
\b Returning the special value \cw{MOVE_UI_UPDATE} indicates that the input
event has resulted in a change being made to the \c{game_ui} which
@ -1080,7 +1085,8 @@ strings can be written to disk when saving the game and fed to
The return value from \cw{interpret_move()} is expected to be
dynamically allocated if and only if it is not either \cw{NULL}
\e{or} the special string constant \c{MOVE_UI_UPDATE}.
\e{or} one of the special string constants \cw{MOVE_UNUSED},
\cw{MOVE_NO_EFFECT}, or \cw{MOVE_UI_UPDATE}.
After this function is called, the back end is permitted to rely on
some subsequent operations happening in sequence: