reports Namespace Reference

Unit and team statistics. More...


Classes

struct  element
struct  report

Enumerations

enum  TYPE {
  UNIT_NAME, UNIT_TYPE, UNIT_RACE, UNIT_LEVEL,
  UNIT_SIDE, UNIT_AMLA, UNIT_TRAITS, UNIT_STATUS,
  UNIT_ALIGNMENT, UNIT_ABILITIES, UNIT_HP, UNIT_XP,
  UNIT_ADVANCEMENT_OPTIONS, UNIT_MOVES, UNIT_WEAPONS, UNIT_IMAGE,
  UNIT_PROFILE, TIME_OF_DAY, TURN, GOLD,
  VILLAGES, NUM_UNITS, UPKEEP, EXPENSES,
  INCOME, TERRAIN, POSITION, SIDE_PLAYING,
  OBSERVERS, REPORT_COUNTDOWN, REPORT_CLOCK, SELECTED_TERRAIN,
  EDIT_LEFT_BUTTON_FUNCTION, NUM_REPORTS
}
enum  { UNIT_REPORTS_BEGIN = UNIT_NAME, UNIT_REPORTS_END = UNIT_PROFILE+1 }
enum  { STATUS_REPORTS_BEGIN = TIME_OF_DAY, STATUS_REPORTS_END = NUM_REPORTS }

Functions

report generate_report (TYPE type, std::map< reports::TYPE, std::string > report_contents, const gamemap &map, unit_map &units, const std::vector< team > &teams, const team &current_team, unsigned int current_side, unsigned int playing_side, const gamemap::location &loc, const gamemap::location &mouseover, const gamemap::location &displayed_unit_hex, const gamestatus &status, const std::set< std::string > &observers, const config &level)
const std::string & report_name (TYPE type)
report generate_report (TYPE type, std::map< reports::TYPE, std::string > report_contents, const gamemap &map, unit_map &units, const std::vector< team > &teams, const team &current_team, unsigned int current_side, int unsigned active_side, const gamemap::location &loc, const gamemap::location &mouseover, const gamemap::location &displayed_unit_hex, const gamestatus &status, const std::set< std::string > &observers, const config &level)


Detailed Description

Unit and team statistics.

This module can provide statistics and information, such as these presented in the in-game windows rightmost and upper borders. This is primarily characteristics of units and teams.


Enumeration Type Documentation

anonymous enum

Enumerator:
UNIT_REPORTS_BEGIN 
UNIT_REPORTS_END 

Definition at line 38 of file reports.hpp.

anonymous enum

Enumerator:
STATUS_REPORTS_BEGIN 
STATUS_REPORTS_END 

Definition at line 39 of file reports.hpp.

Enumerator:
UNIT_NAME 
UNIT_TYPE 
UNIT_RACE 
UNIT_LEVEL 
UNIT_SIDE 
UNIT_AMLA 
UNIT_TRAITS 
UNIT_STATUS 
UNIT_ALIGNMENT 
UNIT_ABILITIES 
UNIT_HP 
UNIT_XP 
UNIT_ADVANCEMENT_OPTIONS 
UNIT_MOVES 
UNIT_WEAPONS 
UNIT_IMAGE 
UNIT_PROFILE 
TIME_OF_DAY 
TURN 
GOLD 
VILLAGES 
NUM_UNITS 
UPKEEP 
EXPENSES 
INCOME 
TERRAIN 
POSITION 
SIDE_PLAYING 
OBSERVERS 
REPORT_COUNTDOWN 
REPORT_CLOCK 
SELECTED_TERRAIN 
EDIT_LEFT_BUTTON_FUNCTION 
NUM_REPORTS 

Definition at line 28 of file reports.hpp.


Function Documentation

report reports::generate_report ( TYPE  type,
std::map< reports::TYPE, std::string >  report_contents,
const gamemap map,
unit_map units,
const std::vector< team > &  teams,
const team current_team,
unsigned int  current_side,
int unsigned  active_side,
const gamemap::location loc,
const gamemap::location mouseover,
const gamemap::location displayed_unit_hex,
const gamestatus status,
const std::set< std::string > &  observers,
const config level 
)

report reports::generate_report ( TYPE  type,
std::map< reports::TYPE, std::string >  report_contents,
const gamemap map,
unit_map units,
const std::vector< team > &  teams,
const team current_team,
unsigned int  current_side,
unsigned int  playing_side,
const gamemap::location loc,
const gamemap::location mouseover,
const gamemap::location displayed_unit_hex,
const gamestatus status,
const std::set< std::string > &  observers,
const config level 
)

Definition at line 38 of file generate_report.cpp.

References _, _n, reports::report::add_image(), reports::report::add_text(), unit_type::alignment_description(), unit_type::alignment_id(), font::BAD_TEXT, unit_map::begin(), calculate_team_data(), preferences::clock_format(), font::color2markup(), team::countdown_time(), data, EDIT_LEFT_BUTTON_FUNCTION, unit_ability_list::empty(), unit_map::end(), EXPENSES, team_data::expenses, find_visible_unit(), game_config::flag_icon_image, game_config::flag_rgb, preferences::flip_time(), team::fogged(), team::get_side_colour_index(), gamemap::get_terrain(), gamemap::get_terrain_info(), gamestatus::get_time_of_day(), team::gold(), GOLD, font::GRAY_TEXT, unit_ability_list::highest(), if(), time_of_day::image, INCOME, terrain_type::income_description(), terrain_type::income_description_ally(), terrain_type::income_description_enemy(), terrain_type::income_description_own(), team::is_enemy(), gamemap::is_village(), time_of_day::lawful_bonus, map, terrain_type::name(), time_of_day::name, team_data::net_income, font::NORMAL_TEXT, font::NULL_MARKUP, NUM_UNITS, gamestatus::number_of_turns(), game_config::observer_image, OBSERVERS, t_translation::OFF_MAP_USER, gamemap::on_board(), POSITION, REPORT_CLOCK, REPORT_COUNTDOWN, round_damage(), SELECTED_TERRAIN, team::shrouded(), SIDE_PLAYING, utils::string_bool(), string_table, team_units(), TERRAIN, TIME_OF_DAY, timeofday_at(), gamestatus::turn(), TURN, gamemap::underlying_union_terrain(), UNIT_ABILITIES, UNIT_ADVANCEMENT_OPTIONS, UNIT_ALIGNMENT, UNIT_AMLA, UNIT_HP, UNIT_IMAGE, UNIT_LEVEL, UNIT_MOVES, UNIT_NAME, UNIT_PROFILE, UNIT_RACE, UNIT_REPORTS_BEGIN, UNIT_REPORTS_END, UNIT_SIDE, UNIT_STATUS, UNIT_TRAITS, UNIT_TYPE, UNIT_WEAPONS, UNIT_XP, team_data::upkeep, UPKEEP, team::uses_shroud(), village_owner(), gamemap::villages(), team_data::villages, and VILLAGES.

Referenced by game_display::draw_report().

const std::string & reports::report_name ( TYPE  type  ) 

Definition at line 38 of file reports.cpp.

References NUM_REPORTS, and report_names.

Referenced by display::refresh_report().


Generated by doxygen 1.5.5 on 23 May 2008 for The Battle for Wesnoth
Gna! | Forum | Wiki | CIA | devdocs