racket/collects/teachpack/htdp/scribblings/hangman.scrbl
2011-07-06 05:35:17 -04:00

33 lines
1.3 KiB
Racket

#lang scribble/doc
@(require scribble/manual "shared.rkt"
(for-label racket teachpack/htdp/hangman))
@teachpack["hangman"]{Hangman}
@defmodule[#:require-form beginner-require htdp/hangman]
The teachpack implements the callback functions for playing a
@emph{Hangman} game, based on a function designed by a student. The player
guesses a letter and the program responds with an answer that indicates
how many times, if at all, the letter occurs in the secret word.
@defproc[(hangman [make-word (-> symbol? symbol? symbol? word?)][reveal (-> word? word? word?)][draw-next-part (-> symbol? true)]) true]{
Chooses a ``secret'' three-letter word and uses the given functions to
manage the @emph{Hangman} game.}
@defproc[(hangman-list
[reveal-for-list (-> symbol? (list-of symbol?) (list-of symbol?)
(list-of symbol?))]
[draw-next-part (-> symbol? true)]) true]{
Chooses a ``secret'' word---a list of symbolic letters---and uses the given
functions to manage the @emph{Hangman} game:
@racket[reveal-for-list] determines how many times the chosen letter occurs
in the secret word;
@racket[draw-next-part] is given the symbolic name of a body part and draws
it on a separately managed canvas.
}
In addition, the teachpack re-exports the entire functionality of the
drawing library; see @secref{draw} for documentation.