src/chess/rules.h

changeset 186
8230904458a7
parent 184
93c81539b702
equal deleted inserted replaced
185:c0acc89d6c01 186:8230904458a7
525 const char *mstr, Color color, Move *move); 525 const char *mstr, Color color, Move *move);
526 526
527 /** 527 /**
528 * Calculates the move string within the specified move. 528 * Calculates the move string within the specified move.
529 * 529 *
530 * This corrects any missing check / checkmate flags, first. 530 * The string calculated in short algebraic notation.
531 * 531 * The @p gamestate is needed to determine how to disambiguate the move,
532 * Do not call this function after eval_move() or eval_move_strict(). 532 * if necessary.
533 *
534 * Recommended to be called before apply_move() so that a clean
535 * move string is added to the list of recorded moves.
533 * 536 *
534 * @param gamestate the current game state 537 * @param gamestate the current game state
535 * @param move the move data 538 * @param move the move data
536 */ 539 */
537 void format_move(const GameState *gamestate, Move *move); 540 void format_move(const GameState *gamestate, Move *move);

mercurial