R/units.R

In kiernann/aaa: Simulate WWII board game battles

#' List land units
#'
#' @param i Number of infantry units.
#' @param a Number of artillery units.
#' @param t Number of tank units.
#' @param f Number of fighter units.
#' @param b Number of bomber units.
#' @return A list of integer counts for each land unit.
#' @examples
#' land_units(i = 6, a = 2, t = 1)
#' @export
land_units <- function(i = 0, a = 0, t = 0, f = 0, b = 0) {
  list(
    infantry = i,
    artillery = a,
    tanks = t,
    fighters = f,
    bombers = b
  )
}

#' List sea units
#'
#' @param t Number of transport units.
#' @param s Number of submarine units.
#' @param d Number of destroyer units.
#' @param c Number of cruiser units.
#' @param a Number of aircraft carrier units.
#' @param b Number of battleship units.
#' @return A list of integer counts for each land unit.
#' @examples
#' sea_units(s = 6, a = 2, b = 1)
#' @export
sea_units <- function(t = 0, s = 0, d = 0, c = 0, a = 0, b = 0) {
  list(
    transports = t,
    submarines = s,
    destroyers = d,
    cruisers = c,
    air_carriers = a,
    battleships = b
  )
}