Wordify.Rules.LetterBag

Documentation

data LetterBag

Instances

Eq LetterBag

Show LetterBag

validLetters :: LetterBag -> Map Char Tile

makeBag :: FilePath -> IO (Either ScrabbleError LetterBag)

Creates a letter bag from a file where each line contains a space delimited letter character, letter value, and letter distribution. A blank letter is represented by a '_' character and has a disribution, but no value.

If successful, the letter bag is shuffled before it is returned.

tiles :: LetterBag -> [Tile]

bagFromTiles :: [Tile] -> IO LetterBag

Creates a letter bag from a list of tiles. The order of the tiles is retained in the resulting letter bag.

This function is effectful as it is necessary to create a stdGen for list to allow it to be shuffled using this generator in the future.

makeBagUsingGenerator :: [Tile] -> StdGen -> LetterBag

Creates a letter bag using a list of tiles, and a generator which should be used when shuffling the bag. This function allows a game to be stepped through from the beginning where the moves and original generator were recorded, with any shuffling yielding the same bag as in the original game.

takeLetters :: LetterBag -> Int -> Maybe ([Tile], LetterBag)

Takes n numbers from a letter bag, yielding Nothing if there is not enough tiles left in the bag or a Just tuple where the left value is the taken tiles, and the right value is the new bag.

exchangeLetters :: LetterBag -> [Tile] -> Maybe ([Tile], LetterBag)

Exchanges given tiles for the same number of tiles from the bag. The exchanged letters are added to the bag, the bag is then shuffled, and then the same number of tiles as exchanged are drawn from the bag.

Returns Nothing if there are not enough letters in the bag to exchange the given tiles for. Otherwise returns Just with a tuple with the tiles given, and the new letterbag.

shuffleBag :: LetterBag -> LetterBag

Shuffles the contents of a letter bag. The bag is shuffled using the random generator which was created while constructing the bag.

This function should not be used when creating an additional game with a new letter bag as the same seed value will be shared across games (meaning tiles will come out of the bag in the same order.) When constructing an additional game, use shuffleWithNewGenerator.

shuffleWithNewGenerator :: LetterBag -> IO LetterBag

Shuffles a letter bag using a new random generator. This function should be used when spawning a new game using a letter bag with all the tiles remaining so that letter bags are unique between game instances.

bagSize :: LetterBag -> Int

getGenerator :: LetterBag -> StdGen

Get the letter bag's current generator, which will be used to shuffle the contents of the bag in the next exchange or shuffle. If taken at the start of the game, with the original list of tiles in the bag in order, the game moves may be replayed in order with the original results of any shuffle retained.