From a9af3fda1d784c42d486a019a0a4e947f762af70 Mon Sep 17 00:00:00 2001 From: Ben Harris Date: Sun, 4 Jun 2023 18:42:58 +0100 Subject: Rename UI_UPDATE as MOVE_UI_UPDATE All the other constants named UI_* are special key names that can be passed to midend_process_key(), but UI_UPDATE is a special return value from the back-end interpret_move() function instead. This renaming makes the distinction clear and provides a naming convention for future special return values from interpret_move(). --- devel.but | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'devel.but') diff --git a/devel.but b/devel.but index bbf98a4..a17d3b9 100644 --- a/devel.but +++ b/devel.but @@ -1062,7 +1062,7 @@ divide mouse coordinates by it.) in response to the input event; the puzzle was not interested in it at all. -\b Returning the special value \cw{UI_UPDATE} indicates that the input +\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 will require a redraw of the game window, but that no actual \e{move} was made (i.e. no new \c{game_state} needs to be created). @@ -1080,7 +1080,7 @@ 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{UI_UPDATE}. +\e{or} the special string constant \c{MOVE_UI_UPDATE}. After this function is called, the back end is permitted to rely on some subsequent operations happening in sequence: @@ -5804,7 +5804,7 @@ be: \b Put cursor position fields in the \c{game_ui}. \b \cw{interpret_move()} responds to arrow keys by modifying the -cursor position fields and returning \cw{UI_UPDATE}. +cursor position fields and returning \cw{MOVE_UI_UPDATE}. \b \cw{interpret_move()} responds to some other button \dash either \cw{CURSOR_SELECT} or some more specific thing like a number key \dash -- cgit v1.1