WordGuess
=========



A simple Wordle-like word guessing game.



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





RPCS
----

.. function:: WordGuess.getWordList(length: BoundedInteger<3, 20>)

    Get a list of all the possible words given a word length

    **Arguments:**

    - ``length: BoundedInteger<3, 20>`` (`BoundedInteger </docs/fundamentals/rpc-arg-types.html#BoundedInteger>`__) - Length of word

    **Returns:** ``List<String>`` (`List </docs/fundamentals/rpc-arg-types.html#List>`__ | `String </docs/fundamentals/rpc-arg-types.html#String>`__) - word list


.. function:: WordGuess.giveUp()

    Give up on the current game and learn the target word


.. function:: WordGuess.guess(word: BoundedString<3, 10>)

    Guess the word. Returns a list where each item is the feedback for
    the corresponding character. Feedback is a "3" if the character is
    correct, "2" if it is correct but in the wrong place, and "1" if the
    letter is not present in the word.

    **Arguments:**

    - ``word: BoundedString<3, 10>`` (`BoundedString </docs/fundamentals/rpc-arg-types.html#BoundedString>`__) - Guess for this round


.. function:: WordGuess.start(length: BoundedInteger<3, 10>?)

    Start the guessing game by having the computer choose a random word
    with the given length.

    **Arguments:**

    - ``length: BoundedInteger<3, 10>?`` (`BoundedInteger </docs/fundamentals/rpc-arg-types.html#BoundedInteger>`__) - Length of word to search for (default ``5``)