time_of_day Struct Reference

Object which defines a time of day with associated bonuses, image, sounds etc. More...

#include <time_of_day.hpp>

Collaboration diagram for time_of_day:

List of all members.

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.
	time_of_day (const config &cfg)
	Construct a time of day from config.
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.
Public Attributes
int	lawful_bonus
	The % bonus lawful units receive.
int	bonus_modified
std::string	image
	The image to be displayed in the game status.
t_string	name
std::string	id
std::string	image_mask
	The image that is to be laid over all images while this time of day lasts.
tod_color	color
	The color modifications that should be made to the game board to reflect the time of day.
std::string	sounds
	List of "ambient" sounds associated with this time_of_day, Played at the beginning of turn.

---

Detailed Description

Object which defines a time of day with associated bonuses, image, sounds etc.

Definition at line 49 of file time_of_day.hpp.

---

Constructor & Destructor Documentation

time_of_day::time_of_day

(

)

[explicit]

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 39 of file time_of_day.cpp.

Referenced by parse_times().

Here is the caller graph for this function:

time_of_day::time_of_day

(

const config &

cfg

)

[explicit]

Construct a time of day from config.

Definition at line 29 of file time_of_day.cpp.

---

Member Function Documentation

void time_of_day::parse_times	(	const config &	cfg,
		std::vector< time_of_day > &	normal_times
	)			[static]

Parse config and add time of day entries into passed vector.

Definition at line 63 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().

Here is the call graph for this function:

Here is the caller graph for this function:

void time_of_day::write

(

config &

cfg

)

const

Definition at line 51 of file time_of_day.cpp.

References tod_color::b, color, tod_color::g, id, image, image_mask, lawful_bonus, name, and tod_color::r.

Referenced by WML_HANDLER_FUNCTION().

Here is the caller graph for this function:

---

Member Data Documentation

int time_of_day::bonus_modified

Definition at line 66 of file time_of_day.hpp.

Referenced by tod_manager::get_illuminated_time_of_day(), intf_get_time_of_day(), and time_of_day_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 83 of file time_of_day.hpp.

Referenced by display::get_terrain_images(), intf_get_time_of_day(), gui2::teditor_settings::pre_show(), display::update_tod(), and write().

std::string time_of_day::id

Definition at line 71 of file time_of_day.hpp.

Referenced by replay::add_attack(), events::console_handler::do_layers(), display::draw_hex(), intf_get_time_of_day(), terrain_filter::match_internal(), and write().

std::string time_of_day::image

The image to be displayed in the game status.

Definition at line 69 of file time_of_day.hpp.

Referenced by intf_get_time_of_day(), time_of_day_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 77 of file time_of_day.hpp.

Referenced by display::draw_hex(), game_display::new_turn(), and write().

int time_of_day::lawful_bonus

The % bonus lawful units receive.

Chaotics receive -lawful_bonus.

Definition at line 65 of file time_of_day.hpp.

Referenced by combat_modifier(), tod_manager::get_illuminated_time_of_day(), intf_get_time_of_day(), terrain_filter::match_internal(), ai::readonly_context_impl::power_projection(), time_of_day_at(), and write().

t_string time_of_day::name

Definition at line 70 of file time_of_day.hpp.

Referenced by intf_get_time_of_day(), ai::readonly_context_impl::is_active(), time_of_day_at(), gui2::teditor_settings::update_selected_tod_info(), 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 89 of file time_of_day.hpp.

Referenced by play_controller::do_init_side().

---

The documentation for this struct was generated from the following files:

• time_of_day.hpp
• time_of_day.cpp