Dokumentace třídy Config

Konfigurace hry. ...

#include <config.h>

Diagram tříd pro Config:

Collaboration graph
[vysvětlivky]

Seznam všech členů.

Veřejné metody

 Config ()
 Inicializace konfigu ze souboru.
 ~Config ()
 Destruktor.
const std::string & language () const
 Zvolený jazyk.
bool visible_presumption () const
 Viditelná předpověď výbuchu.
bool split_screen () const
 Rozdělení obrazovky v multiplayeru.
Uint16 speed () const
 Rychlost hry.
Uint16 move_period () const
 Perioda pohybu.
bool fullscreen () const
 Zapnutý/vypnutý celoobrazovkový režim.
bool sound () const
SDLKey player (Uint16 player_num, KEY_ACTIONS action) const
 Nastavená klávesa.

Privátní typy

typedef std::vector
< std::vector< SDLKey > > 
players_t
 Typ seznamu hráčů a jejich kláves.

Privátní metody

void load_configuration_ ()
 Načte konfiguraci z XML.
void load_properties_ (TiXmlElement *rootEl)
 Načte vlastnosti hry z XML.
void load_players_ (TiXmlElement *rootEl)
 Načte klávesy hráčů z XML.
bool set_key_action_ (Uint16 player_num, KEY_ACTIONS action, SDLKey key)
 Nastaví klávesu akci.
bool set_key_action_ (Uint16 player_num, KEY_ACTIONS action, SDLKey key, Uint16 &conflict_pl, KEY_ACTIONS &conflict_ac)
 Nastaví klávesu akci.
KEY_ACTIONS name2action_ (const std::string &name)
 Převede název akce na akci.
const char * action2name_ (KEY_ACTIONS action)
 Převede akci na její název.
void save_configuration_ ()
 Uloží konfiguraci do souboru.
void set_properties_ (TiXmlElement *rootEl)
 Nastaví vlastnosti hry do XML.
void set_players_ (TiXmlElement *rootEl)
 Nastaví klávesy hráčů do XML.

Privátní atributy

players_t players_
 Seznam kláves hráčů.
bool players_changed_
 True pokud se zmenily klávesy hráčů.
std::vector< language_tlanguages_
std::string language_
Language language_class_
Uint16 speed_
bool visible_presumption_
bool split_screen_
bool fullscreen_
bool sound_
KeyNames keyNames_
 Pro pojmenování kláves.

Friends

class MenuOptions
class MenuOptionsControls
class BonusIllnessConfused

Třídy

struct  language_t


Detailní popis

Konfigurace hry.

Instance třídy Config obstarává konfiguraci hry od jejího naloadování, managování a ukládání. Config může vytvořit pouze jedinou instanci, která je typicky vytvořena při startu aplikace a zrušena při ukončení. Implementuje nástroje, kterými tuto skutečnost hlídá a poskytuje svůj pointer globálně, prostřednictvím fce Config::get_instance(). Ve svých strukturách uchovává nastavení různých částí hry. Přes jednoduchý interface toto nastavení poskytuje.

Pozor:
Musí být inicializován až po window_init().

Dokumentace k členským typům

typedef std::vector< std::vector< SDLKey > > Config::players_t [private]

Typ seznamu hráčů a jejich kláves.


Dokumentace konstruktoru a destruktoru

Config::Config (  ) 

Inicializace konfigu ze souboru.

Inicializuje klávesy hráčů, nahrává konfiguraci hry.

Výjimky:
string Chybová hláška, pokud již je instance třídy Config vytvořena.

Tato funkce volá...

Config::~Config (  ) 

Destruktor.

Zruší instanci třídy Config.


Dokumentace k metodám

const std::string& Config::language (  )  const [inline]

Zvolený jazyk.

bool Config::visible_presumption (  )  const [inline]

Viditelná předpověď výbuchu.

bool Config::split_screen (  )  const [inline]

Rozdělení obrazovky v multiplayeru.

Uint16 Config::speed (  )  const [inline]

Rychlost hry.

Uint16 Config::move_period (  )  const

Perioda pohybu.

Návratová hodnota:
Perioda vypočtená z konstantně přednastavené rychlosti a odchylky rychlosti z dynamické konfigurace.

bool Config::fullscreen (  )  const [inline]

Zapnutý/vypnutý celoobrazovkový režim.

Tuto funkci volají...

bool Config::sound (  )  const [inline]

SDLKey Config::player ( Uint16  player_num,
KEY_ACTIONS  action 
) const

Nastavená klávesa.

Parametry:
player_num číslo hráče
action akce
Návratová hodnota:
Klávesa přiřazená akci hráče.

void Config::load_configuration_ (  )  [private]

Načte konfiguraci z XML.

Načte konfiguraci ze souboru CONFIG_FILENAME.

Tato funkce volá...

Tuto funkci volají...

void Config::load_properties_ ( TiXmlElement *  rootEl  )  [private]

Načte vlastnosti hry z XML.

Načte z XML souboru nastavení hry. Konkrétně načítá: * Rychlost hry * Odhad exploze * Rozdělit obrazovku * Celoobrazovkový mód * Povolit zvuk * Jazyk

Parametry:
rootEl root element xml souboru
Výjimky:
string Chybové hlášení pokud není rychlost ve stanovených mezích.

Tato funkce volá...

Tuto funkci volají...

void Config::load_players_ ( TiXmlElement *  rootEl  )  [private]

Načte klávesy hráčů z XML.

Načte z XML souboru nastavení kláves hráčů.

Parametry:
rootEl root element xml souboru

Tato funkce volá...

Tuto funkci volají...

bool Config::set_key_action_ ( Uint16  player_num,
KEY_ACTIONS  action,
SDLKey  key 
) [private]

Nastaví klávesu akci.

Nastaví klávesu pro akci hráče.

Parametry:
player_num číslo hráče, jehož nastavení měníme
action akce, jíž přiřazujeme klávesu
key klávesa
Návratová hodnota:
True pokud nedošlo ke konfliktu, jinak false.
Viz také:
set_key_action_()

Tuto funkci volají...

bool Config::set_key_action_ ( Uint16  player_num,
KEY_ACTIONS  action,
SDLKey  key,
Uint16 &  conflict_pl,
KEY_ACTIONS conflict_ac 
) [private]

Nastaví klávesu akci.

Nastaví klávesu pro akci hráče. Kontroluje jestli došlo ke konfliktu s jiným hráčem, pokud ano, konfliktní hráč přijde o své nastavení. Nastavovaná akce dostane vždy svou klávesu výhradně.

Parametry:
player_num číslo hráče, jehož nastavení měníme
action akce, jíž přiřazujeme klávesu
key klávesa
conflict_pl číslo hráče, který je v konfliktu - výstupní parametr
conflict_ac akce hráče, která je v konfliktu - výstupní parametr
Návratová hodnota:
True pokud nedošlo ke konfliktu, jinak false.

KEY_ACTIONS Config::name2action_ ( const std::string &  name  )  [private]

Převede název akce na akci.

Parametry:
name název akce
Návratová hodnota:
Akce příslušící zadanému názvu.
Výjimky:
string Chybová hláška, pokud názvu neodpovídá žádná akce.

Tuto funkci volají...

const char * Config::action2name_ ( KEY_ACTIONS  action  )  [private]

Převede akci na její název.

Parametry:
action akce
Návratová hodnota:
Název příslušící zadané akci.
Výjimky:
string Chybová hláška, pokud akci neumíme přiřadit název.

Tuto funkci volají...

void Config::save_configuration_ (  )  [private]

Uloží konfiguraci do souboru.

Uloží konfiguraci do souboru CONFIG_FILENAME.

Viz také:
set_properties_(), set_players_()

Tato funkce volá...

void Config::set_properties_ ( TiXmlElement *  rootEl  )  [private]

Nastaví vlastnosti hry do XML.

Uloží do XML nastavení hry. Konkrétně ukládá: * Rychlost hry * Odhad exploze * Rozdělit obrazovku * Celoobrazovkový mód * Povolit zvuk * Jazyk

Parametry:
rootEl root element xml souboru

Tato funkce volá...

Tuto funkci volají...

void Config::set_players_ ( TiXmlElement *  rootEl  )  [private]

Nastaví klávesy hráčů do XML.

Uloží do XML nastavení kláves hráčů.

Parametry:
rootEl root element xml souboru

Tato funkce volá...

Tuto funkci volají...


Dokumentace k friends

friend class MenuOptions [friend]

friend class MenuOptionsControls [friend]

friend class BonusIllnessConfused [friend]


Dokumentace k datovým členům

Seznam kláves hráčů.

bool Config::players_changed_ [private]

True pokud se zmenily klávesy hráčů.

std::vector<language_t> Config::languages_ [private]

std::string Config::language_ [private]

Uint16 Config::speed_ [private]

bool Config::split_screen_ [private]

bool Config::fullscreen_ [private]

bool Config::sound_ [private]

Pro pojmenování kláves.


Dokumentace pro tuto třídu byla generována z následujících souborů:

Generováno Mon May 24 21:57:34 2010 pro projekt Bombic 2 programem  doxygen 1.5.6