Hangman
=======



The Hangman Service provides helpers for mediating a distributed game of hangman.



.. toctree::
    :maxdepth: 2
    :titlesonly:
    :caption: RPC Categories





RPCS
----

.. function:: Hangman.getCurrentlyKnownWord()

    Get current word for the game

    **Returns:** ``String`` (`String </docs/fundamentals/rpc-arg-types.html#String>`__) - Current word in use


.. function:: Hangman.getWrongCount()

    Get number of wrong guesses made

    **Returns:** ``Integer`` (`Integer </docs/fundamentals/rpc-arg-types.html#Integer>`__) - Number of wrong guesses


.. function:: Hangman.guess(letter: BoundedString<1, 1>)

    Make a guess in the game

    **Arguments:**

    - ``letter: BoundedString<1, 1>`` (`BoundedString </docs/fundamentals/rpc-arg-types.html#BoundedString>`__) - Letter to guess


.. function:: Hangman.isWordGuessed()

    Get if word has been guessed

    **Returns:** ``Boolean`` (`Boolean </docs/fundamentals/rpc-arg-types.html#Boolean>`__) - State of word


.. function:: Hangman.setWord(word: String)

    Set current word for the game

    **Arguments:**

    - ``word: String`` (`String </docs/fundamentals/rpc-arg-types.html#String>`__) - New word to use