Object which defines a time of day with associated bonuses, image, sounds etc. More...
#include <time_of_day.hpp>
Public Member Functions | |
time_of_day () | |
A default-constructed time of day object shouldn't really be used so this only loads some null values. More... | |
time_of_day (const config &cfg) | |
Construct a time of day from config. More... | |
bool | operator== (const time_of_day &o) const |
void | write (config &cfg) const |
Static Public Member Functions | |
static void | parse_times (const config &cfg, std::vector< time_of_day > &normal_times) |
Parse config and add time of day entries into passed vector. More... | |
Public Attributes | |
int | lawful_bonus |
The % bonus lawful units receive. More... | |
int | bonus_modified |
std::string | image |
The image to be displayed in the game status. More... | |
t_string | name |
t_string | description |
std::string | id |
std::string | image_mask |
The image that is to be laid over all images while this time of day lasts. More... | |
tod_color | color |
The color modifications that should be made to the game board to reflect the time of day. More... | |
std::string | sounds |
List of "ambient" sounds associated with this time_of_day, Played at the beginning of turn. More... | |
Object which defines a time of day with associated bonuses, image, sounds etc.
Definition at line 48 of file time_of_day.hpp.
time_of_day::time_of_day | ( | ) |
A default-constructed time of day object shouldn't really be used so this only loads some null values.
Ideally, there should be getters for properties that would emit a warning when such an object is actually used, but it does not seem necessary at the moment.
Definition at line 41 of file time_of_day.cpp.
Referenced by parse_times().
|
explicit |
Construct a time of day from config.
Definition at line 29 of file time_of_day.cpp.
|
inline |
Definition at line 61 of file time_of_day.hpp.
References bonus_modified, color, id, image, image_mask, lawful_bonus, name, and sounds.
|
static |
Parse config and add time of day entries into passed vector.
Definition at line 68 of file time_of_day.cpp.
References config::child_range(), and time_of_day().
Referenced by tod_manager::add_time_area(), tod_manager::replace_schedule(), and tod_manager::tod_manager().
Definition at line 54 of file time_of_day.cpp.
References description, id, image, image_mask, lawful_bonus, name, and sounds.
Referenced by game_events::WML_HANDLER_FUNCTION().
int time_of_day::bonus_modified |
Definition at line 71 of file time_of_day.hpp.
Referenced by tod_manager::get_illuminated_time_of_day(), game_lua_kernel::intf_get_time_of_day(), operator==(), time_of_day_at(), and unit_box_at().
tod_color time_of_day::color |
The color modifications that should be made to the game board to reflect the time of day.
Definition at line 89 of file time_of_day.hpp.
Referenced by display::draw_hex(), display::get_terrain_images(), game_lua_kernel::intf_get_time_of_day(), operator==(), gui2::tcustom_tod::pre_show(), unit_box_at(), and display::update_tod().
t_string time_of_day::description |
Definition at line 76 of file time_of_day.hpp.
Referenced by write().
std::string time_of_day::id |
Definition at line 77 of file time_of_day.hpp.
Referenced by events::console_handler::do_layers(), display::draw_hex(), replay_helper::get_attack(), game_lua_kernel::intf_get_time_of_day(), ai::readonly_context_impl::is_active(), terrain_filter::match_internal(), operator==(), time_of_day_at(), and write().
std::string time_of_day::image |
The image to be displayed in the game status.
Definition at line 74 of file time_of_day.hpp.
Referenced by game_lua_kernel::intf_get_time_of_day(), operator==(), time_of_day_at(), unit_box_at(), and write().
std::string time_of_day::image_mask |
The image that is to be laid over all images while this time of day lasts.
Definition at line 83 of file time_of_day.hpp.
Referenced by display::draw_hex(), game_display::new_turn(), operator==(), and write().
int time_of_day::lawful_bonus |
The % bonus lawful units receive.
Chaotics receive -lawful_bonus.
Definition at line 70 of file time_of_day.hpp.
Referenced by combat_modifier(), tod_manager::get_illuminated_time_of_day(), game_lua_kernel::intf_get_time_of_day(), terrain_filter::match_internal(), operator==(), ai::readonly_context_impl::power_projection(), time_of_day_at(), unit_box_at(), and write().
t_string time_of_day::name |
Definition at line 75 of file time_of_day.hpp.
Referenced by game_lua_kernel::intf_get_time_of_day(), operator==(), time_of_day_at(), unit_box_at(), and write().
std::string time_of_day::sounds |
List of "ambient" sounds associated with this time_of_day, Played at the beginning of turn.
Definition at line 95 of file time_of_day.hpp.
Referenced by play_controller::init_side_end(), operator==(), and write().