game_events Namespace Reference

Domain specific events. More...

Namespaces
	builtin_conditions
	context

Classes
struct	entity_location
class	event_handler
class	event_handlers
class	manager
	The game event manager loads the scenario configuration object, and ensures that events are handled according to the scenario configuration for its lifetime. More...
struct	pump_impl
struct	queued_event
class	wmi_manager
class	wml_action
class	wml_event_pump
class	wml_menu_item

Typedefs
using	handler_ptr = std::shared_ptr< event_handler >
using	weak_handler_ptr = std::weak_ptr< event_handler >
using	handler_list = std::list< weak_handler_ptr >
using	pump_result_t = std::tuple< bool, bool >

Functions
	WML_HANDLER_FUNCTION (clear_global_variable,, pcfg)
	Experimental data persistence. More...
static void	on_replay_error (const std::string &message)
	WML_HANDLER_FUNCTION (do_command,, cfg)
	WML_HANDLER_FUNCTION (get_global_variable,, pcfg)
	Experimental data persistence. More...
	WML_HANDLER_FUNCTION (modify_turns,, cfg)
	WML_HANDLER_FUNCTION (move_unit_fake,, cfg)
	Moving a 'unit' - i.e. More...
	WML_HANDLER_FUNCTION (move_units_fake,, cfg)
	WML_HANDLER_FUNCTION (recall,, cfg)
	If we should recall units that match a certain description. More...
	WML_HANDLER_FUNCTION (replace_map,, cfg)
	Experimental map replace. More...
	WML_HANDLER_FUNCTION (set_global_variable,, pcfg)
	Experimental data persistence. More...
	WML_HANDLER_FUNCTION (set_variables,, cfg)
	WML_HANDLER_FUNCTION (store_relative_direction,, cfg)
	Store the relative direction from one hex to another in a WML variable. More...
	WML_HANDLER_FUNCTION (store_rotate_map_location,, cfg)
	Store the rotation of one hex around another in a WML variable. More...
	WML_HANDLER_FUNCTION (store_time_of_day,, cfg)
	Store time of day config in a WML variable. More...
	WML_HANDLER_FUNCTION (tunnel,, cfg)
	WML_HANDLER_FUNCTION (unit,, cfg)
	If we should spawn a new unit on the map somewhere. More...
	WML_HANDLER_FUNCTION (on_undo, event_info, cfg)
bool	conditional_passed (const vconfig &cond)
bool	matches_special_filter (const config &cfg, const vconfig &filter)

Detailed Description

Domain specific events.

This module defines the game's event mechanism. Events might be units moving or fighting, or when victory or defeat occurs. A scenario's configuration file will define actions to take when certain events occur. This module is responsible for making sure that when the events occur, the actions take place.

Game events have nothing to do with mouse movement, keyboard events, etc. These kinds of system events can be handled using namespace events

Typedef Documentation

handler_list

using game_events::handler_list = typedef std::list<weak_handler_ptr>

Definition at line 26 of file fwd.hpp.

handler_ptr

using game_events::handler_ptr = typedef std::shared_ptr<event_handler>

Definition at line 24 of file fwd.hpp.

pump_result_t

using game_events::pump_result_t = typedef std::tuple<bool , bool >

Definition at line 28 of file fwd.hpp.

weak_handler_ptr

using game_events::weak_handler_ptr = typedef std::weak_ptr<event_handler>

Definition at line 25 of file fwd.hpp.

Function Documentation

conditional_passed()

bool game_events::conditional_passed

(

const vconfig &

cond

)

Definition at line 184 of file conditional_wml.cpp.

References vconfig::all_ordered().

Referenced by game_events::wml_menu_item::can_show(), game_events::wml_event_pump::filter_event(), intf_eval_conditional(), and storyscreen::story_parser::resolve_wml().

matches_special_filter()

bool game_events::matches_special_filter	(	const config &	cfg,
		const vconfig &	filter
	)

Definition at line 207 of file conditional_wml.cpp.

References vconfig::get_parsed_config(), and WRN_NG.

Referenced by game_events::wml_event_pump::filter_event().

on_replay_error()

static void game_events::on_replay_error ( const std::string &  message )

static

Definition at line 265 of file action_wml.cpp.

References ERR_NG.

Referenced by WML_HANDLER_FUNCTION().

WML_HANDLER_FUNCTION() [1/16]

game_events::WML_HANDLER_FUNCTION	(	clear_global_variable	,
		pcfg
	)

Experimental data persistence.

Todo:

Finish experimenting.

Definition at line 259 of file action_wml.cpp.

References resources::controller, and verify_and_clear_global_variable().

WML_HANDLER_FUNCTION() [2/16]

game_events::WML_HANDLER_FUNCTION	(	do_command	,
		cfg
	)

Definition at line 273 of file action_wml.cpp.

References events::commands_disabled, resources::controller, ERR_NG, resources::gamedata, synced_context::get_synced_state(), on_replay_error(), game_data::phase(), game_data::PLAY, synced_context::run_in_synced_context_if_not_already(), game_data::START, synced_context::UNSYNCED, and resources::whiteboard.

WML_HANDLER_FUNCTION() [3/16]

game_events::WML_HANDLER_FUNCTION	(	get_global_variable	,
		pcfg
	)

Experimental data persistence.

Todo:

Finish experimenting.

Definition at line 348 of file action_wml.cpp.

References verify_and_get_global_variable().

WML_HANDLER_FUNCTION() [4/16]

game_events::WML_HANDLER_FUNCTION	(	modify_turns	,
		cfg
	)

Definition at line 353 of file action_wml.cpp.

References config_attribute_value::empty(), ERR_NG, resources::gamedata, game_display::get_singleton(), tod_manager::modify_turns_by_wml(), game_display::new_turn(), tod_manager::number_of_turns(), tod_manager::set_number_of_turns_by_wml(), tod_manager::set_turn_by_wml(), config_attribute_value::to_int(), resources::tod_manager, and tod_manager::turn().

WML_HANDLER_FUNCTION() [5/16]

game_events::WML_HANDLER_FUNCTION	(	move_unit_fake	,
		cfg
	)

Moving a 'unit' - i.e.

a dummy unit that is just moving for the visual effect

Definition at line 382 of file action_wml.cpp.

References fake_unit_ptr::get(), fake_unit_ptr::get_unit_ptr(), unit_display::move_unit(), map_location::NDIRECTIONS, game_config::path, and utils::split().

WML_HANDLER_FUNCTION() [6/16]

game_events::WML_HANDLER_FUNCTION	(	move_units_fake	,
		cfg
	)

Definition at line 405 of file action_wml.cpp.

References DBG_NG, resources::fake_units, LOG_NG, unit_display::move_unit(), map_location::NDIRECTIONS, utf8::size(), and utils::split().

WML_HANDLER_FUNCTION() [7/16]

game_events::WML_HANDLER_FUNCTION	(	recall	,
		cfg
	)

If we should recall units that match a certain description.

If you change attributes specific to [recall] (that is, not a Standard Unit Filter) be sure to update data/lua/wml_tag, auto_recall feature for [role] to reflect your changes.

FIXME: we should design the WML to avoid these types of collisions; filters should be named consistently and always have a distinct scope.

Definition at line 465 of file action_wml.cpp.

References recall_list_manager::begin(), vconfig::child(), DBG_NG, recall_list_manager::end(), recall_list_manager::erase(), filename_, unit_map::find_leaders(), pathfind::find_vacant_tile(), resources::gameboard, utf8::index(), LOG_NG, LOG_WML, game_board::map(), unit_filter::matches(), map_location::null_location(), map_location::parse_direction(), actions::place_recruit(), config::remove_attribute(), utf8::size(), gamemap_base::special_locations(), game_board::teams(), game_board::units(), and pathfind::VACANT_ANY.

WML_HANDLER_FUNCTION() [8/16]

game_events::WML_HANDLER_FUNCTION	(	replace_map	,
		cfg
	)

Experimental map replace.

Todo:

Finish experimenting.

Definition at line 588 of file action_wml.cpp.

References deprecated_message(), e, resources::gameboard, game_display::get_singleton(), display::get_singleton(), ai::manager::get_singleton(), mp_sync::get_user_choice(), INDEFINITE, game_board::map(), game_display::needs_rebuild(), ai::manager::raise_map_changed(), gamemap::read(), display::reload_map(), game_board::replace_map(), wml_exception::show(), gamemap_base::total_height(), gamemap_base::total_width(), and lg::wml_error().

WML_HANDLER_FUNCTION() [9/16]

game_events::WML_HANDLER_FUNCTION	(	set_global_variable	,
		pcfg
	)

Experimental data persistence.

Todo:

Finish experimenting.

Definition at line 653 of file action_wml.cpp.

References resources::controller, and verify_and_set_global_variable().

WML_HANDLER_FUNCTION() [10/16]

game_events::WML_HANDLER_FUNCTION	(	set_variables	,
		cfg
	)

Definition at line 659 of file action_wml.cpp.

References config::append(), variable_info_mutable< V >::append_array(), variable_info< V >::as_array(), c, config::debug(), vconfig::empty(), t_string::empty(), ERR_NG, variable_info< V >::explicit_index(), resources::gamedata, vconfig::get_config(), game_data::get_variable_access_read(), game_data::get_variable_access_write(), i, variable_info_mutable< V >::insert_array(), variable_info_mutable< V >::merge_array(), p, utils::REMOVE_EMPTY, variable_info_mutable< V >::replace_array(), utils::split(), and utils::STRIP_SPACES.

WML_HANDLER_FUNCTION() [11/16]

game_events::WML_HANDLER_FUNCTION	(	store_relative_direction	,
		cfg
	)

Store the relative direction from one hex to another in a WML variable.

This is mainly useful as a diagnostic tool, but could be useful for some kind of scenario.

Definition at line 769 of file action_wml.cpp.

References variable_info< V >::as_scalar(), ERR_NG, resources::gamedata, map_location::get_relative_dir(), game_data::get_variable_access_write(), map_location::write_direction(), and WRN_NG.

WML_HANDLER_FUNCTION() [12/16]

game_events::WML_HANDLER_FUNCTION	(	store_rotate_map_location	,
		cfg
	)

Store the rotation of one hex around another in a WML variable.

In increments of 60 degrees, clockwise. This is mainly useful as a diagnostic tool, but could be useful for some kind of scenario.

Definition at line 807 of file action_wml.cpp.

References variable_info< V >::as_container(), ERR_NG, resources::gamedata, game_data::get_variable_access_write(), and WRN_NG.

WML_HANDLER_FUNCTION() [13/16]

game_events::WML_HANDLER_FUNCTION	(	store_time_of_day	,
		cfg
	)

Store time of day config in a WML variable.

This is useful for those who are too lazy to calculate the corresponding time of day for a given turn, or if the turn / time-of-day sequence mutates in a scenario.

Definition at line 846 of file action_wml.cpp.

References variable_info< V >::as_container(), ERR_NG, resources::gamedata, tod_manager::get_time_of_day(), game_data::get_variable_access_write(), resources::tod_manager, and time_of_day::write().

WML_HANDLER_FUNCTION() [14/16]

game_events::WML_HANDLER_FUNCTION	(	tunnel	,
		cfg
	)

Definition at line 868 of file action_wml.cpp.

References pathfind::manager::add(), ERR_WML, pathfind::manager::remove(), utils::split(), and resources::tunnels.

WML_HANDLER_FUNCTION() [15/16]

game_events::WML_HANDLER_FUNCTION	(	unit	,
		cfg
	)

If we should spawn a new unit on the map somewhere.

Definition at line 894 of file action_wml.cpp.

References unit_creator::add_unit(), unit_creator::allow_add_to_recall(), unit_creator::allow_discover(), unit_creator::allow_get_village(), unit_creator::allow_invalidate(), unit_creator::allow_rename_side(), unit_creator::allow_show(), config_attribute_value::blank(), config::clear(), unit::create(), DBG_NG, config::debug(), ERR_NG, resources::gameboard, resources::gamedata, config::get(), game_board::get_team(), game_data::get_variable_cfg(), config::remove_attribute(), utf8::size(), and game_board::teams().

WML_HANDLER_FUNCTION() [16/16]

game_events::WML_HANDLER_FUNCTION	(	on_undo	,
		event_info	,
		cfg
	)

Definition at line 944 of file action_wml.cpp.

References synced_context::add_undo_commands().