play_game provides an interactive interface for guessing words
based on a game made by create_game. If you call this function
directly, it will create the game itself. Assigning the results to a variable
will allow you to pause and continue the game later by running
play_game(prev_game).
play_game(
game = NULL,
keep_central_first = FALSE,
restart = FALSE,
game_letters = NULL,
central = NULL,
num_letters = 7,
min_word_length = 4,
dictionary = "normal",
obscenities = FALSE
)A game object created by create_game. If null, the
default, play_game will create a new game object. Alternatively, if
using a previous game, game will contain both the game and
state variables.
Logical. Should the game always display the "central" letter first when printing the letters. Defaults to FALSE.
Logical. Only useful when trying anew with an existing game. Deletes previous guesses and starts with a clean slate, while using the same letters (and therefore words).
The remaining arguments are passed to the create_game function
and all can be left out.
User-selected letters to use in the game. Will
result in a warning if more letters are chosen than num_letters. If
including, this should be a character string, e.g., "stb".
The central (that is, required) letter. If not
provided, will be randomly chosen from among the game_letters.
The number of letters for the game; defaults to 7, and should be between 6 and 10.
Expected length of words. Defaults to 4 letters, but can be between 2 and 6.
Character string. Choice of how detailed of a dictionary to use. Can be any of "slim", "broad", or "normal". Defaults to "normal", which is recommended.
Logical. Should obscenities be included? Defaults to FALSE.
Regardless of whether you include any inputs, the code will run a
version of the game. If passed a game object from create_game,
the game will use the same letters and words. If passed a previously-played
game from play_game, the game will pick up where you left off, and
remind you of past guesses. Assign play_game to a variable to keep
playing later.
create_game to set up a game without playing.
if (FALSE) {
play_game()
# assuming a saved game called prev_game
play_game(game = prev_game)
# permit obscenities
play_game(keep_central_first = TRUE,
obscenities = TRUE)
}