The Battle for Wesnoth  1.17.0-dev
Classes | Namespaces | Functions
help.hpp File Reference
#include <memory>
#include <string>
Include dependency graph for help.hpp:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  help::help_manager
 The help implementation caches data parsed from the game_config. More...
 

Namespaces

 help
 

Functions

std::unique_ptr< help_manager > help::ensure_cache_lifecycle ()
 Helper function for any of the show_help functions to control the cache's lifecycle; can also be used by any other caller that wants to ensure the cache is reused over multiple show_help calls. More...
 
void help::show_help (const std::string &show_topic, int xloc, int yloc)
 Open the help browser, show topic with id show_topic. More...
 
void help::show_unit_help (const std::string &show_topic, bool has_variations, bool hidden, int xloc, int yloc)
 Open the help browser, show unit with id unit_id. More...
 
void help::show_variation_help (const std::string &unit, const std::string &variation, bool hidden, int xloc, int yloc)
 Open the help browser, show the variation of the unit matching. More...
 
void help::show_terrain_help (const std::string &show_topic, bool hidden, int xloc, int yloc)
 Open the help browser, show terrain with id terrain_id. More...
 
void help::show_unit_description (const unit_type &t)
 
void help::show_unit_description (const unit &u)
 
void help::show_terrain_description (const terrain_type &t)