R/animate_game.R

In piecepackr/ppgames: Piecepack Games

#' Animate a ppn game
#'
#' Animate a ppn game
#' @param game A list containing a parsed ppn game (as parsed by [read_ppn()])
#' @inheritParams piecepackr::animate_piece
#' @seealso [piecepackr::animate_piece()]
#' @return Nothing, as a side effect saves an animation of ppn game
#' @examples
#'   game_file <- system.file("ppn/tic-tac-toe.ppn", package = "ppgames")
#'   game <- read_ppn(game_file)[[1]]
#'   if (require("gifski")) {
#'     animate_game(game, file = "tic-tac-toe.gif")
#'     unlink("tic-tac-toe.gif")
#'   }
#' @export
animate_game <- function(game, file = "animation.gif", annotate = TRUE, ...,
                         .f = piecepackr::grid.piece, cfg = NULL, envir = NULL,
                         n_transitions = 0L, n_pauses = 1L, fps = n_transitions + n_pauses,
                         width = NULL, height = NULL, ppi = NULL,
                         new_device = TRUE, annotation_scale = NULL) {
    animate_piece(game$dfs, file = file, annotate = annotate, ...,
                  .f = .f, cfg = cfg, envir = envir, n_transitions = n_transitions,
                  n_pauses = n_pauses, fps = fps, width = width, height = height,
                  ppi = ppi, new_device = new_device, annotation_scale = annotation_scale)
}