Skip to contents

Generate piecepack pieces

Source: R/piecepack_helpers.r
piecepack_pieces.Rd

piecepack_coins() generates a data frame of piecepack coins. piecepack_dice() generates a data frame of piecepack dice. piecepack_matchsticks() generates a data frame of piecepack matchsticks. piecepack_pawns() generates a data frame of piecepack pawns. piecepack_tiles() generates a data frame of piecepack tiles.

Usage

piecepack_coins(
  ...,
  side = "face",
  piece_side = paste0("coin_", side),
  suit = rep(1:4, each = 6L),
  rank = rep.int(1:6, 4L),
  cfg = "piecepack",
  x = as.double(rep.int(1:6, 4L)),
  y = as.double(rep(4:1, each = 6L)),
  angle = 0,
  length.out = NA_integer_
)

piecepack_dice(
  ...,
  suit = 1:4,
  rank = 1L,
  cfg = "piecepack",
  x = as.double(1:4),
  y = 1,
  angle = 0,
  length.out = NA_integer_
)

piecepack_matchsticks(
  ...,
  side = "face",
  piece_side = paste0("matchstick_", side),
  suit = rep(1:4, each = 6L),
  rank = rep.int(1:6, 4L),
  cfg = "piecepack",
  x = as.double(rep.int(1:6, 4L)),
  y = 3 * rep(4:1, each = 6L),
  angle = 0,
  length.out = NA_integer_
)

piecepack_pawns(
  ...,
  side = "face",
  piece_side = paste0("pawn_", side),
  suit = 1:4,
  cfg = "piecepack",
  x = as.double(1:4),
  y = 1,
  angle = 0,
  length.out = NA_integer_
)

piecepack_tiles(
  ...,
  side = "face",
  piece_side = paste0("tile_", side),
  suit = rep(1:4, each = 6L),
  rank = rep.int(1:6, 4L),
  cfg = "piecepack",
  x = 2 * rep.int(1:6, 4L),
  y = 2 * rep(4:1, each = 6L),
  angle = 0,
  length.out = NA_integer_
)

Arguments

...

Should be left empty.

side

Either "face" or "back".

piece_side

Either "tile_face" or "tile_back".

suit

Integer vector with values between 1L and 4L. 1L is "suns", 2L is "moons", 3L is "crowns", 4L is "arms". Will be coerced by piece_suit().

rank

Integer vector with values between 1L (null) and 6L (five). Will be coerced by piece_rank().

cfg

"piecepack" or perhaps "playing_cards_expansion", "dual_piecepacks_expansion", or "subpack".

x, y

Cartesian coordinates (numeric vectors)

angle

Rotation of piece (numeric vector of degrees, counter-clockwise). Will be coerced by piece_angle().

length.out

The number of pieces. Not needed if all the arguments are the same length (or of length one) and this length is the same as the number of desired pieces.

Value

A tibble::tibble() data frame with the following columns:

  • "piece_side"

  • "suit"

  • "rank"

  • "cfg" (optional, defaults to "piecepack")

  • "x"

  • "y"

  • "angle" (optional, defaults to 0).

This data frame is compatible with piecepackr::render_piece() and likely ppcli::cat_piece().

Examples

df_coins <- piecepack_coins()
df_dice <- piecepack_dice()
df_pawns <- piecepack_pawns()
df_tiles <- piecepack_tiles()