#include <synced_context.hpp>
Classes | |
struct | event_info |
class | server_choice |
Public Types | |
enum | synced_state { UNSYNCED , SYNCED , LOCAL_CHOICE } |
typedef std::deque< event_info > | event_list |
Static Public Member Functions | |
static bool | run (const std::string &commandname, const config &data, bool use_undo=true, bool show=true, synced_command::error_handler_function error_handler=default_error_function) |
Sets the context to 'synced', initialises random context, and calls the given function. More... | |
static bool | run_and_store (const std::string &commandname, const config &data, bool use_undo=true, bool show=true, synced_command::error_handler_function error_handler=default_error_function) |
static bool | run_and_throw (const std::string &commandname, const config &data, bool use_undo=true, bool show=true, synced_command::error_handler_function error_handler=default_error_function) |
static bool | run_in_synced_context_if_not_already (const std::string &commandname, const config &data, bool use_undo=true, bool show=true, synced_command::error_handler_function error_handler=default_error_function) |
Checks whether we are currently running in a synced context, and if not we enters it. More... | |
static synced_state | get_synced_state () |
static bool | is_synced () |
static bool | is_unsynced () |
static void | set_synced_state (synced_state newstate) |
Should only be called form set_scontext_synced, set_scontext_local_choice. More... | |
static std::string | generate_random_seed () |
Generates a new seed for a synced event, by asking the 'server'. More... | |
static void | pull_remote_user_input () |
called from get_user_choice while waiting for a remove user choice. More... | |
static void | send_user_choice () |
called from get_user_choice to send a recently made choice to the other clients. More... | |
static void | default_error_function (const std::string &message) |
A function to be passed to run_in_synced_context to assert false on error (the default). More... | |
static void | just_log_error_function (const std::string &message) |
A function to be passed to run_in_synced_context to log the error. More... | |
static void | ignore_error_function (const std::string &message) |
A function to be passed to run_in_synced_context to ignore the error. More... | |
static std::shared_ptr< randomness::rng > | get_rng_for_action () |
static bool | is_simultaneous () |
static void | reset_is_simultaneous () |
Sets is_simultaneous_ = false, called when entering the synced context. More... | |
static void | set_is_simultaneous () |
Sets is_simultaneous_ = true, called using a user choice that is not the currently playing side. More... | |
static void | block_undo (bool do_block=true) |
static void | reset_block_undo () |
static bool | undo_blocked () |
static void | set_last_unit_id (int id) |
static int | get_unit_id_diff () |
static config | ask_server_choice (const server_choice &) |
If we are in a mp game, ask the server, otherwise generate the answer ourselves. More... | |
static event_list & | get_undo_commands () |
static void | add_undo_commands (const config &commands, const game_events::queued_event &ctx) |
static void | add_undo_commands (int fcn_idx, const game_events::queued_event &ctx) |
static void | add_undo_commands (int fcn_idx, const config &args, const game_events::queued_event &ctx) |
static void | reset_undo_commands () |
static bool | ignore_undo () |
Static Private Attributes | |
static synced_state | state_ = synced_context::UNSYNCED |
Weather we are in a synced move, in a user_choice, or none of them. More... | |
static bool | is_simultaneous_ = false |
As soon as get_user_choice is used with side != current_side (for example in generate_random_seed) other sides execute the command simultaneously and is_simultaneously is set to true. More... | |
static bool | is_undo_blocked_ = false |
static int | last_unit_id_ = 0 |
Used to restore the unit id manager when undoing. More... | |
static event_list | undo_commands_ {} |
Actions to be executed when the current action is undone. More... | |
Definition at line 28 of file synced_context.hpp.
typedef std::deque<event_info> synced_context::event_list |
Definition at line 202 of file synced_context.hpp.
Enumerator | |
---|---|
UNSYNCED | |
SYNCED | |
LOCAL_CHOICE |
Definition at line 31 of file synced_context.hpp.
|
static |
Definition at line 361 of file synced_context.cpp.
References undo_commands_.
Referenced by game_lua_kernel::cfun_undoable_event(), and game_lua_kernel::intf_add_undo_actions().
|
static |
Definition at line 371 of file synced_context.cpp.
References undo_commands_.
|
static |
Definition at line 366 of file synced_context.cpp.
References undo_commands_.
|
static |
If we are in a mp game, ask the server, otherwise generate the answer ourselves.
Definition at line 274 of file synced_context.cpp.
References replay::at_end(), actions::undo_list::clear(), resources::controller, DBG_REPLAY, config::debug(), do_replay_handle(), ERR_REPLAY, replay::get_next_action(), config::has_child(), play_controller::increase_server_request_number(), play_controller::is_networked_mp(), is_synced(), synced_context::server_choice::local_choice(), config::mandatory_child(), synced_context::server_choice::name(), controller_base::play_slice(), replay::process_error(), pull_remote_user_input(), resources::recorder, synced_context::server_choice::request_id(), replay::revert_action(), synced_context::server_choice::send_request(), set_is_simultaneous(), resources::undo_stack, replay::user_input(), and WRN_REPLAY.
Referenced by game_state::add_side_wml(), team::change_controller_by_wml(), and generate_random_seed().
|
static |
Definition at line 207 of file synced_context.cpp.
References actions::undo_list::clear(), resources::controller, is_undo_blocked_, play_controller::send_actions(), and resources::undo_stack.
Referenced by play_controller::do_init_side(), play_controller::finish_side_turn_events(), play_controller::start_game(), and SYNCED_COMMAND_HANDLER_FUNCTION().
|
static |
A function to be passed to run_in_synced_context to assert false on error (the default).
Definition at line 153 of file synced_context.cpp.
References ERR_REPLAY.
|
static |
Generates a new seed for a synced event, by asking the 'server'.
Definition at line 193 of file synced_context.cpp.
References ask_server_choice(), and config_attribute_value::str().
Referenced by get_rng_for_action().
|
static |
Definition at line 249 of file synced_context.cpp.
References resources::classification, resources::gamedata, generate_random_seed(), and game_classification::random_mode.
|
inlinestatic |
Definition at line 88 of file synced_context.hpp.
References state_.
Referenced by do_replay_handle(), events::console_handler::is_enabled(), is_synced(), is_unsynced(), leave_synced_context::leave_synced_context(), actions::move_unit_and_record(), run_in_synced_context_if_not_already(), set_scontext_synced_base::set_scontext_synced_base(), game_lua_kernel::synced_state(), actions::teleport_unit_and_record(), game_events::WML_HANDLER_FUNCTION(), leave_synced_context::~leave_synced_context(), and set_scontext_synced_base::~set_scontext_synced_base().
|
inlinestatic |
Definition at line 203 of file synced_context.hpp.
References undo_commands_.
Referenced by actions::undo_action::undo_action().
|
static |
Definition at line 230 of file synced_context.cpp.
References resources::gameboard, n_unit::id_manager::get_save_id(), is_synced(), last_unit_id_, and game_board::unit_id_manager().
|
static |
A function to be passed to run_in_synced_context to ignore the error.
Definition at line 164 of file synced_context.cpp.
References DBG_REPLAY.
Referenced by ai::recall_result::do_execute(), wb::recall::execute(), and events::menu_handler::recall().
|
static |
Definition at line 376 of file synced_context.cpp.
References resources::controller, play_controller::current_team(), and team::is_ai().
|
inlinestatic |
Definition at line 142 of file synced_context.hpp.
References is_simultaneous_.
|
inlinestatic |
Definition at line 97 of file synced_context.hpp.
References get_synced_state(), and SYNCED.
Referenced by actions::undo_list::apply_shroud_changes(), ask_server_choice(), game_display::display_unit_hex(), ai::attack_result::do_execute(), do_replay_handle(), get_unit_id_diff(), mp_sync::get_user_choice(), mp_sync::get_user_choice_multiple_sides(), game_display::highlight_hex(), game_lua_kernel::intf_has_achievement(), game_lua_kernel::intf_has_sub_achievement(), unit::mark_clone(), side_filter::match_internal(), unit::set_underlying_id(), and undo_blocked().
|
inlinestatic |
Definition at line 106 of file synced_context.hpp.
References get_synced_state(), and UNSYNCED.
Referenced by wb::manager::can_modify_game_state(), playmp_controller::send_actions(), and undo_blocked().
|
static |
A function to be passed to run_in_synced_context to log the error.
Definition at line 159 of file synced_context.cpp.
References ERR_REPLAY.
|
static |
called from get_user_choice while waiting for a remove user choice.
Definition at line 237 of file synced_context.cpp.
References resources::controller, and play_controller::receive_actions().
Referenced by ask_server_choice(), and user_choice_manager::pull().
|
inlinestatic |
Definition at line 156 of file synced_context.hpp.
References is_undo_blocked_.
Referenced by set_scontext_synced_base::set_scontext_synced_base().
|
inlinestatic |
Sets is_simultaneous_ = false, called when entering the synced context.
Definition at line 148 of file synced_context.hpp.
References is_simultaneous_.
Referenced by set_scontext_synced_base::set_scontext_synced_base().
|
inlinestatic |
Definition at line 212 of file synced_context.hpp.
References undo_commands_.
Referenced by set_scontext_synced_base::set_scontext_synced_base().
|
static |
Sets the context to 'synced', initialises random context, and calls the given function.
The plan is that in replays and in real game the same function is called. However, if you cannot call this function you can also use set_scontext_synced directly (use it like it's used in this method).
Movement commands are currently treated specially because actions::move_unit returns a value and some function use that value. Maybe I should add a way to return a value here.
AI attacks are also treated special because the ai wants to pass advancement_aspects.
Redoing does normally not take place in a synced context, because we saved the dependent=true replay commands in the replay stack data. There are also no events of similar fired when redoing an action (in most cases).
commandname | The command to run. |
data | The data to use with the command. |
use_undo | This parameter is used to ignore undos during an ai move to optimize. |
show | |
error_handler | An error handler for the case that data contains invalid data. |
Definition at line 46 of file synced_context.cpp.
References play_controller::check_victory(), actions::undo_list::clear(), resources::controller, data, DBG_REPLAY, set_scontext_synced::do_final_checkup(), synced_command::registry(), send_user_choice(), gui2::dialogs::tip::show(), undo_blocked(), and resources::undo_stack.
Referenced by do_replay_handle(), actions::undo_list::redo(), and run_and_store().
|
static |
Definition at line 87 of file synced_context.cpp.
References replay::add_synced_command(), resources::controller, data, ERR_REPLAY, resources::recorder, run(), gui2::dialogs::tip::show(), and replay::undo().
Referenced by playsingle_controller::play_ai_turn(), playmp_controller::play_human_turn(), and run_and_throw().
|
static |
Definition at line 108 of file synced_context.cpp.
References resources::controller, data, play_controller::maybe_throw_return_to_play_side(), run_and_store(), and gui2::dialogs::tip::show().
Referenced by events::mouse_handler::attack_enemy_(), gui2::dialogs::unit_recall::dismiss_unit(), events::console_handler::do_choose_level(), events::console_handler::do_event(), ai::attack_result::do_execute(), events::console_handler::do_fog(), events::console_handler::do_gold(), events::console_handler::do_lua(), events::console_handler::do_next_level(), events::menu_handler::do_recruit(), events::console_handler::do_set_var(), events::console_handler::do_shroud(), events::console_handler::do_terrain(), events::console_handler::do_turn(), events::console_handler::do_turn_limit(), events::console_handler::do_unit(), wb::recall::execute(), game_events::wml_menu_item::fire_event(), events::menu_handler::kill_unit(), events::menu_handler::recall(), run_in_synced_context_if_not_already(), wb::manager::set_active(), events::menu_handler::toggle_shroud_updates(), and events::menu_handler::update_shroud_now().
|
static |
Checks whether we are currently running in a synced context, and if not we enters it.
This is never called from so_replay_handle.
Definition at line 122 of file synced_context.cpp.
References data, ERR_REPLAY, get_synced_state(), LOCAL_CHOICE, synced_command::registry(), run_and_throw(), gui2::dialogs::tip::show(), SYNCED, and UNSYNCED.
Referenced by ai::recall_result::do_execute(), ai::recruit_result::do_execute(), game_events::wml_menu_item::fire_event(), and game_events::WML_HANDLER_FUNCTION().
|
static |
called from get_user_choice to send a recently made choice to the other clients.
Does not receive any data from the network any sends data.
Definition at line 243 of file synced_context.cpp.
References resources::controller, play_controller::send_actions(), and undo_blocked().
Referenced by user_choice_manager::ask_local_choice(), and run().
|
static |
Sets is_simultaneous_ = true, called using a user choice that is not the currently playing side.
Definition at line 201 of file synced_context.cpp.
References actions::undo_list::clear(), is_simultaneous_, and resources::undo_stack.
Referenced by ask_server_choice(), and user_choice_manager::user_choice_manager().
|
inlinestatic |
Definition at line 164 of file synced_context.hpp.
References id, and last_unit_id_.
Referenced by set_scontext_synced_base::set_scontext_synced_base().
|
inlinestatic |
Should only be called form set_scontext_synced, set_scontext_local_choice.
Definition at line 112 of file synced_context.hpp.
References state_.
Referenced by leave_synced_context::leave_synced_context(), set_scontext_synced_base::set_scontext_synced_base(), leave_synced_context::~leave_synced_context(), and set_scontext_synced_base::~set_scontext_synced_base().
|
static |
Definition at line 215 of file synced_context.cpp.
References resources::controller, game_data::end_turn_forced(), resources::gamedata, randomness::generator, randomness::rng::get_random_calls(), play_controller::is_regular_game_end(), is_simultaneous_, is_synced(), is_undo_blocked_, and is_unsynced().
Referenced by user_choice_manager::ask_local_choice(), actions::recall_unit(), actions::recruit_unit(), run(), playmp_controller::send_actions(), send_user_choice(), and SYNCED_COMMAND_HANDLER_FUNCTION().
|
inlinestaticprivate |
As soon as get_user_choice is used with side != current_side (for example in generate_random_seed) other sides execute the command simultaneously and is_simultaneously is set to true.
It's impossible to undo data that has been sent over the network.
false = we are on a local turn and haven't sent anything yet.
TODO: it would be better if the following variable were not static.
Definition at line 231 of file synced_context.hpp.
Referenced by is_simultaneous(), reset_is_simultaneous(), set_is_simultaneous(), and undo_blocked().
|
inlinestaticprivate |
Definition at line 232 of file synced_context.hpp.
Referenced by block_undo(), reset_block_undo(), and undo_blocked().
|
inlinestaticprivate |
Used to restore the unit id manager when undoing.
Definition at line 235 of file synced_context.hpp.
Referenced by get_unit_id_diff(), and set_last_unit_id().
|
inlinestaticprivate |
Weather we are in a synced move, in a user_choice, or none of them.
Definition at line 220 of file synced_context.hpp.
Referenced by get_synced_state(), and set_synced_state().
|
inlinestaticprivate |
Actions to be executed when the current action is undone.
Definition at line 238 of file synced_context.hpp.
Referenced by add_undo_commands(), get_undo_commands(), and reset_undo_commands().