R/check_game_status.R

In BoardGameSimulator/HootOwlHoot: Simulates the board game Hoot Owl Hoot!

#' Check Hoot Owl Hoot! game
#'
#' Game can be a win, loss, or in progress.
#'
#' @param game A game object
#' @return A character string with values win, loss, or in progress.
#' @export
#' @seealso \code{\link{setup}}
#' @examples
#' game <- setup()
#' check(game)
#'
check_game_status <- function(game) {
  if (game$sun == 0) return("loss")
  if (all(!game$board$occupied)) return("win")
  return("in progress")
}