Labyrinth
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends
Classes | Typedefs | Functions | Variables
LxS::Game::Help Namespace Reference

in-game help messages system More...

Classes

class  HelpMessageLine
 single line of help message (containing single paragraph of text or single picture or both) More...
 
class  HelpMessage
 Single help message identigfied by name. More...
 
class  HelpManager
 class for managing GlobalHelpMessagesDatabase More...
 
class  HintBox
 a box with help on some aspect of game More...
 
class  Help
 sequence of hintboxes More...
 

Typedefs

typedef std::map< std::string,
HelpMessage
GlobalHelpMessagesDatabase_t
 
typedef std::vector
< HelpMessageLine
HelpMessageVector
 

Functions

HintBoxDisplayHintBoxIfRequired (std::string hint)
 

Variables

GlobalHelpMessagesDatabase_t GlobalHelpMessagesDatabase
 map help entry to message
 
LxS::System::MyMutex GlobalHelpMessagesDatabaseMutex
 mutual exclusion object for synchronizing GlobalHelpMessagesDatabase access
 
std::vector< std::string > HelpOrder
 

Detailed Description

in-game help messages system

Function Documentation

HintBox * LxS::Game::Help::DisplayHintBoxIfRequired ( std::string  hint)

if hint named "hint" wasn't displayed, display it right now.