print_hint_list: Prints hints to help get all the answers

Description Usage Arguments Details Value See Also Examples

View source: R/hint_cheat.R

Description

print_hint_list is a helper function which identifies the number of words for the given set of letters, and (if desired) identifies what letters (two or three) words begin with.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
print_hint_list(
  game_letters = NULL,
  central = NULL,
  num_letters = 7,
  min_word_length = 4,
  dictionary = "normal",
  obscenities = FALSE,
  game = NULL,
  hint = NULL
)

Arguments

game_letters

The letters to identify words from. These should be a character string (e.g., "polemic"). (Required, if game is not provided.)

central

The central (that is, required) letter (optional). If not provided, will be randomly chosen from among the game_letters.

num_letters

The number of letters for the game; defaults to 7, and should be between 6 and 10.

min_word_length

Expected length of words. Defaults to 4 letters, but can be between 2 and 6.

dictionary

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.

obscenities

Logical. Should obscenities be included? Defaults to FALSE.

game

A holoalphabetic game from play_game or create_game. If included, no other parameters are required.

state

State of a holoalphabetic game; provided from current gameplay.

Details

These words may or may not be the same as those identified with other word sets; you can make minor changes by changing the chosen dictionary. This function is called by play_game when choosing to get hints (with "[h]" entered instead of a guess). You can choose to get hints of the first two of three letters, or none.

Value

When called directly (or through gameplay), this prints hints to help you find all answers.

See Also

play_game to play the game

print_answers to get all answers

Examples

1
2
print_hint_list(game = create_game("craking"))
print_hint_list("balmntu")

jdbest/holoalphabetic documentation built on Feb. 10, 2022, 10:11 p.m.