pc_creator {dndR}R Documentation

Create a Player Character (PC)

Description

Stat out a player character (PC) of specified race and class using your preferred method for rolling ability scores.

Usage

pc_creator(
  class = NULL,
  race = NULL,
  score_method = "4d6",
  scores_rolled = FALSE,
  scores_df = NULL,
  quiet = FALSE
)

Arguments

class

(character) name of character class (supported classes returned by 'dnd_classes()'). Also supports "random" and will randomly select a supported class. Random class returned as message

race

(character) name of character race (supported classes returned by 'dnd_races()'). Also supports "random" and will randomly select a supported race. Random race returned as message

score_method

(character) preferred method of rolling for ability scores "4d6", "3d6", or "1d20" ("d20" also accepted synonym of "1d20"). Only values accepted by 'ability_scores()' are accepted here

scores_rolled

(logical) whether ability scores have previously been rolled (via 'ability_scores()'). Defaults to FALSE

scores_df

(dataframe) if 'scores_rolled' is TRUE, the name of the dataframe object returned by 'ability_scores()'

quiet

(logical) whether to print warnings if the total score is very low or one ability score is very low

Value

(dataframe) raw ability score, race modifier, total ability score, and the roll modifier for each of the six abilities

Examples

# Create a PC's base statistics from scratch
pc_creator(class = 'barbarian', race = 'half orc', score_method = "4d6", quiet = TRUE)

# Or you can roll separately and then create a character with that dataframe
my_scores <- ability_scores(method = "4d6", quiet = TRUE)
pc_creator(class = 'sorcerer', race = 'dragonborn', scores_rolled = TRUE, scores_df = my_scores)


[Package dndR version 2.0.0 Index]