wfl::event_callable Class Reference

An object representing the state of the current event; equivalent to Lua's wesnoth.current.event_context. More...

#include <callable_objects.hpp>

Inheritance diagram for wfl::event_callable:

Public Member Functions
	event_callable (const game_events::queued_event &event)
void	get_inputs (formula_input_vector &inputs) const override
variant	get_value (const std::string &key) const override
Public Member Functions inherited from wfl::formula_callable
	formula_callable (bool has_self=true)
virtual	~formula_callable ()
formula_callable_ptr	fake_ptr ()
const_formula_callable_ptr	fake_ptr () const
variant	query_value (const std::string &key) const
void	mutate_value (const std::string &key, const variant &value)
formula_input_vector	inputs () const
bool	equals (const formula_callable &other) const
bool	less (const formula_callable &other) const
bool	has_key (const std::string &key) const
void	serialize (std::string &str) const
void	subscribe_dtor (callable_die_subscriber *d) const
void	unsubscribe_dtor (callable_die_subscriber *d) const

Private Attributes
const game_events::queued_event &	event_info
std::shared_ptr< attack_type >	first_weapon
std::shared_ptr< attack_type >	second_weapon

Additional Inherited Members
Protected Types inherited from wfl::formula_callable
enum	TYPE {   FORMULA_C , TERRAIN_C , LOCATION_C , UNIT_TYPE_C ,   UNIT_C , ATTACK_TYPE_C , MOVE_PARTIAL_C , MOVE_C ,   ATTACK_C , MOVE_MAP_C }
Protected Member Functions inherited from wfl::formula_callable
virtual void	set_value (const std::string &key, const variant &)
virtual int	do_compare (const formula_callable *callable) const
virtual void	serialize_to_string (std::string &) const
Static Protected Member Functions inherited from wfl::formula_callable
template<typename T , typename K >
static variant	convert_map (const std::map< T, K > &input_map)
template<typename T >
static variant	convert_set (const std::set< T > &input_set)
template<typename T >
static variant	convert_vector (const std::vector< T > &input_vector)
static void	add_input (formula_input_vector &inputs, const std::string &key, formula_access access_type=formula_access::read_only)
Protected Attributes inherited from wfl::formula_callable
TYPE	type_
std::set< callable_die_subscriber * >	dtor_notify

Detailed Description

An object representing the state of the current event; equivalent to Lua's wesnoth.current.event_context.

Definition at line 45 of file callable_objects.hpp.

Constructor & Destructor Documentation

event_callable()

wfl::event_callable::event_callable ( const game_events::queued_event &  event )

inline

Definition at line 48 of file callable_objects.hpp.

Member Function Documentation

get_inputs()

void wfl::event_callable::get_inputs ( formula_input_vector &  inputs ) const

overridevirtual

Reimplemented from wfl::formula_callable.

Definition at line 943 of file callable_objects.cpp.

References wfl::formula_callable::add_input(), and wfl::formula_callable::inputs().

get_value()

variant wfl::event_callable::get_value ( const std::string &  key ) const

overridevirtual

Implements wfl::formula_callable.

Definition at line 956 of file callable_objects.cpp.

References game_events::queued_event::data, event_info, first_weapon, game_events::entity_location::get_unit(), config::has_child(), game_events::queued_event::id, game_events::queued_event::loc1, game_events::queued_event::loc2, config::mandatory_child(), game_events::queued_event::name, and second_weapon.

Member Data Documentation

event_info

const game_events::queued_event& wfl::event_callable::event_info

private

Definition at line 53 of file callable_objects.hpp.

Referenced by get_value().

first_weapon

std::shared_ptr<attack_type> wfl::event_callable::first_weapon

mutableprivate

Definition at line 54 of file callable_objects.hpp.

Referenced by get_value().

second_weapon

std::shared_ptr<attack_type> wfl::event_callable::second_weapon

private

Definition at line 54 of file callable_objects.hpp.

Referenced by get_value().

---

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

• formula/callable_objects.hpp
• formula/callable_objects.cpp