Hanabi/Endgame-Analyzer
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

fix comments

Browse source
This commit is contained in:
Maximilian Keßler 2023-11-16 16:22:49 +01:00
parent ea881c5e6a
commit 3eea38ae05
Signed by: max
GPG key ID: BCC5A619923C0BA5
1 changed files with 9 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
include/download.h
View file

@ -17,17 +17,21 @@ namespace Download
std::optional<boost::json::object> open_game_json(char const *filename); std::optional<boost::json::object> open_game_json(char const *filename);
/** /**
* @brief Create game object from given source * @brief Create game object from given source.
* @param game_spec Either an id to download from hanab.live or a filename with a json specification * @param game_id Id to download from hanab.live.
* @param score_goal What score counts as a win for this game. If left empty, the maximum score is inserted. * @param score_goal What score counts as a win for this game. If left empty, the maximum score is inserted.
* @return Game state * @return Game state
* *
* If both turn and draw_pile_break are specified, the game skips until the specified turn or the first time the
* draw pile hits the given size, whichever comes first
*
*/ */
Hanabi::Game get_game(int game_id, std::optional<uint8_t> score_goal); Hanabi::Game get_game(int game_id, std::optional<uint8_t> score_goal);
/**
* @brief Create game object from given source.
* @param filename Filename with a json specification of the game in hanab.live format.
* @param score_goal What score counts as a win for this game. If left empty, the maximum score is inserted.
* @return Game state
*
*/
Hanabi::Game get_game(std::string const & filename, std::optional<uint8_t> score_goal); Hanabi::Game get_game(std::string const & filename, std::optional<uint8_t> score_goal);
} // namespace Download } // namespace Download