Menu Item: formatting and doc cleanup
This commit is contained in:
Charles Dang
parent
dd714a0999
commit
2f18c4cdf6
2 changed files with 289 additions and 239 deletions
|
|
@ -27,10 +27,10 @@
|
|||
#include "actions/undo.hpp"
|
||||
#include "game_config.hpp"
|
||||
#include "game_data.hpp"
|
||||
#include "log.hpp"
|
||||
#include "mouse_handler_base.hpp"
|
||||
#include "hotkey/hotkey_command.hpp"
|
||||
#include "hotkey/hotkey_handler.hpp"
|
||||
#include "log.hpp"
|
||||
#include "mouse_handler_base.hpp"
|
||||
#include "play_controller.hpp"
|
||||
#include "preferences/general.hpp"
|
||||
#include "replay.hpp"
|
||||
|
|
@ -43,82 +43,70 @@ static lg::log_domain log_engine("engine");
|
|||
#define ERR_NG LOG_STREAM(err, log_engine)
|
||||
#define LOG_NG LOG_STREAM(info, log_engine)
|
||||
|
||||
|
||||
// This file is in the game_events namespace.
|
||||
namespace game_events
|
||||
{
|
||||
|
||||
namespace { // Some helpers for construction.
|
||||
|
||||
/**
|
||||
* Build the event name associated with the given menu item id.
|
||||
* This is a separate function so it can be easily shared by multiple
|
||||
* constructors.
|
||||
*/
|
||||
inline std::string make_item_name(const std::string & id)
|
||||
{
|
||||
return std::string("menu item") + (id.empty() ? "" : ' ' + id);
|
||||
}
|
||||
|
||||
/**
|
||||
* Build the hotkey id associated with the given menu item id.
|
||||
* This is a separate function so it can be easily shared by multiple
|
||||
* constructors.
|
||||
*/
|
||||
inline std::string make_item_hotkey(const std::string & id)
|
||||
{
|
||||
return play_controller::hotkey_handler::wml_menu_hotkey_prefix + id;
|
||||
}
|
||||
|
||||
}// anonymous namespace
|
||||
|
||||
namespace
|
||||
{ // Some helpers for construction.
|
||||
|
||||
/**
|
||||
* Constructor for when read from a saved config.
|
||||
* This is the reverse of to_config() and corresponds to reading [menu_item].
|
||||
* Handlers are not initialized.
|
||||
* Build the event name associated with the given menu item id.
|
||||
* This is a separate function so it can be easily shared by multiple
|
||||
* constructors.
|
||||
*/
|
||||
wml_menu_item::wml_menu_item(const std::string& id, const config & cfg) :
|
||||
item_id_(id),
|
||||
event_name_(make_item_name(id)),
|
||||
hotkey_id_(make_item_hotkey(id)),
|
||||
image_(cfg["image"].str()),
|
||||
description_(cfg["description"].t_str()),
|
||||
needs_select_(cfg["needs_select"].to_bool(false)),
|
||||
show_if_(cfg.child_or_empty("show_if"), true),
|
||||
filter_location_(cfg.child_or_empty("filter_location"), true),
|
||||
command_(cfg.child_or_empty("command")),
|
||||
default_hotkey_(cfg.child_or_empty("default_hotkey")),
|
||||
use_hotkey_(cfg["use_hotkey"].to_bool(true)),
|
||||
use_wml_menu_(cfg["use_hotkey"].str() != "only"),
|
||||
is_synced_(cfg["synced"].to_bool(true))
|
||||
inline std::string make_item_name(const std::string& id)
|
||||
{
|
||||
return std::string("menu item") + (id.empty() ? "" : ' ' + id);
|
||||
}
|
||||
|
||||
/**
|
||||
* Build the hotkey id associated with the given menu item id.
|
||||
* This is a separate function so it can be easily shared by multiple
|
||||
* constructors.
|
||||
*/
|
||||
inline std::string make_item_hotkey(const std::string& id)
|
||||
{
|
||||
return play_controller::hotkey_handler::wml_menu_hotkey_prefix + id;
|
||||
}
|
||||
|
||||
} // anonymous namespace
|
||||
|
||||
// Constructor for reading from a saved config.
|
||||
wml_menu_item::wml_menu_item(const std::string& id, const config& cfg)
|
||||
: item_id_(id)
|
||||
, event_name_(make_item_name(id))
|
||||
, hotkey_id_(make_item_hotkey(id))
|
||||
, image_(cfg["image"].str())
|
||||
, description_(cfg["description"].t_str())
|
||||
, needs_select_(cfg["needs_select"].to_bool(false))
|
||||
, show_if_(cfg.child_or_empty("show_if"), true)
|
||||
, filter_location_(cfg.child_or_empty("filter_location"), true)
|
||||
, command_(cfg.child_or_empty("command"))
|
||||
, default_hotkey_(cfg.child_or_empty("default_hotkey"))
|
||||
, use_hotkey_(cfg["use_hotkey"].to_bool(true))
|
||||
, use_wml_menu_(cfg["use_hotkey"].str() != "only")
|
||||
, is_synced_(cfg["synced"].to_bool(true))
|
||||
{
|
||||
if(needs_select_) {
|
||||
ERR_NG << "needs_select=yes is deprecated\n";
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Constructor for when defined in an event.
|
||||
* This is where default values are defined (the other constructors should have
|
||||
* all values to work with).
|
||||
* @param[in] id The id of the menu item.
|
||||
* @param[in] definition The WML defining this menu item.
|
||||
*/
|
||||
wml_menu_item::wml_menu_item(const std::string& id, const vconfig & definition) :
|
||||
item_id_(id),
|
||||
event_name_(make_item_name(id)),
|
||||
hotkey_id_(make_item_hotkey(id)),
|
||||
image_(),
|
||||
description_(),
|
||||
needs_select_(false),
|
||||
show_if_(vconfig::empty_vconfig()),
|
||||
filter_location_(vconfig::empty_vconfig()),
|
||||
command_(),
|
||||
default_hotkey_(),
|
||||
use_hotkey_(true),
|
||||
use_wml_menu_(true),
|
||||
is_synced_(true)
|
||||
// Constructor for items defined in an event.
|
||||
wml_menu_item::wml_menu_item(const std::string& id, const vconfig& definition)
|
||||
: item_id_(id)
|
||||
, event_name_(make_item_name(id))
|
||||
, hotkey_id_(make_item_hotkey(id))
|
||||
, image_()
|
||||
, description_()
|
||||
, needs_select_(false)
|
||||
, show_if_(vconfig::empty_vconfig())
|
||||
, filter_location_(vconfig::empty_vconfig())
|
||||
, command_()
|
||||
, default_hotkey_()
|
||||
, use_hotkey_(true)
|
||||
, use_wml_menu_(true)
|
||||
, is_synced_(true)
|
||||
{
|
||||
// On the off-chance that update() doesn't do it, add the hotkey here.
|
||||
// (Update can always modify it.)
|
||||
|
|
@ -128,144 +116,111 @@ wml_menu_item::wml_menu_item(const std::string& id, const vconfig & definition)
|
|||
update(definition);
|
||||
}
|
||||
|
||||
/**
|
||||
* Constructor for when modified by an event.
|
||||
* (To avoid problems with a menu item's command changing itself, we make a
|
||||
* new menu item instead of modifying the existing one.)
|
||||
* @param[in] id The id of the menu item.
|
||||
* @param[in] definition The WML defining this menu item.
|
||||
* @param[in] original The previous version of the menu item with this id.
|
||||
*/
|
||||
wml_menu_item::wml_menu_item(const std::string& id, const vconfig & definition,
|
||||
const wml_menu_item & original) :
|
||||
item_id_(id),
|
||||
event_name_(make_item_name(id)),
|
||||
hotkey_id_(make_item_hotkey(id)),
|
||||
image_(original.image_),
|
||||
description_(original.description_),
|
||||
needs_select_(original.needs_select_),
|
||||
show_if_(original.show_if_),
|
||||
filter_location_(original.filter_location_),
|
||||
command_(original.command_),
|
||||
default_hotkey_(original.default_hotkey_),
|
||||
use_hotkey_(original.use_hotkey_),
|
||||
use_wml_menu_(original.use_wml_menu_),
|
||||
is_synced_(original.is_synced_)
|
||||
// Constructor for items modified by an event.
|
||||
wml_menu_item::wml_menu_item(const std::string& id, const vconfig& definition, const wml_menu_item& original)
|
||||
: item_id_(id)
|
||||
, event_name_(make_item_name(id))
|
||||
, hotkey_id_(make_item_hotkey(id))
|
||||
, image_(original.image_)
|
||||
, description_(original.description_)
|
||||
, needs_select_(original.needs_select_)
|
||||
, show_if_(original.show_if_)
|
||||
, filter_location_(original.filter_location_)
|
||||
, command_(original.command_)
|
||||
, default_hotkey_(original.default_hotkey_)
|
||||
, use_hotkey_(original.use_hotkey_)
|
||||
, use_wml_menu_(original.use_wml_menu_)
|
||||
, is_synced_(original.is_synced_)
|
||||
{
|
||||
// Apply WML.
|
||||
update(definition);
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* The image associated with this menu item.
|
||||
* The returned string will not be empty; a default will be supplied if needed.
|
||||
*/
|
||||
const std::string & wml_menu_item::image() const
|
||||
const std::string& wml_menu_item::image() const
|
||||
{
|
||||
// Default the image?
|
||||
return image_.empty() ? game_config::images::wml_menu : image_;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns whether or not *this is applicable given the context.
|
||||
* Assumes game variables x1, y1, and unit have been set.
|
||||
* @param[in] hex The hex where the menu will appear.
|
||||
*/
|
||||
bool wml_menu_item::can_show(const map_location & hex, const game_data & data, filter_context & filter_con) const
|
||||
|
||||
bool wml_menu_item::can_show(const map_location& hex, const game_data& data, filter_context& filter_con) const
|
||||
{
|
||||
// Failing the [show_if] tag means no show.
|
||||
if ( !show_if_.empty() && !conditional_passed(show_if_) )
|
||||
if(!show_if_.empty() && !conditional_passed(show_if_)) {
|
||||
return false;
|
||||
}
|
||||
|
||||
// Failing the [fiter_location] tag means no show.
|
||||
if ( !filter_location_.empty() &&
|
||||
!terrain_filter(filter_location_, &filter_con)(hex) )
|
||||
if(!filter_location_.empty() && !terrain_filter(filter_location_, &filter_con)(hex)) {
|
||||
return false;
|
||||
}
|
||||
|
||||
// Failing to have a required selection means no show.
|
||||
if ( needs_select_ && !data.last_selected.valid() )
|
||||
if(needs_select_ && !data.last_selected.valid()) {
|
||||
return false;
|
||||
}
|
||||
|
||||
// Passed all tests.
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Causes the event associated with this item to fire.
|
||||
* Also records the event.
|
||||
* This includes recording the previous select event, if applicable.
|
||||
* The undo stack will be cleared if the event mutated the gamestate.
|
||||
*
|
||||
* @param[in] event_hex The location of the event (where the menu was opened).
|
||||
* @param[in] last_select The location of the most recent "select" event.
|
||||
*/
|
||||
#define STR(X) #X
|
||||
void wml_menu_item::fire_event(const map_location & event_hex, const game_data & data) const
|
||||
void wml_menu_item::fire_event(const map_location& event_hex, const game_data& data) const
|
||||
{
|
||||
if(!this->is_synced())
|
||||
{
|
||||
//It is possible to for example show a help menu during a [delay] of a synced event.
|
||||
if(!this->is_synced()) {
|
||||
// It is possible to for example show a help menu during a [delay] of a synced event.
|
||||
set_scontext_unsynced leave_synced_context;
|
||||
assert(resources::game_events != nullptr);
|
||||
resources::game_events->pump().fire(event_name_, event_hex);
|
||||
return;
|
||||
}
|
||||
const map_location & last_select = data.last_selected;
|
||||
|
||||
const map_location& last_select = data.last_selected;
|
||||
|
||||
// No new player-issued commands allowed while this is firing.
|
||||
const events::command_disabler disable_commands;
|
||||
|
||||
// instead of adding a second "select" event like it was done before, we just fire the select event again, and this time in a synced context.
|
||||
// note that there coudn't be a user choice during the last "select" event because it didn't run in a synced context.
|
||||
if ( needs_select_ && last_select.valid() )
|
||||
{
|
||||
synced_context::run_and_throw("fire_event", replay_helper::get_event(event_name_, event_hex, &last_select));
|
||||
}
|
||||
else
|
||||
{
|
||||
synced_context::run_in_synced_context_if_not_already("fire_event", replay_helper::get_event(event_name_, event_hex, nullptr));
|
||||
// instead of adding a second "select" event like it was done before, we just fire the select event again, and this
|
||||
// time in a synced context.
|
||||
// note that there couldn't be a user choice during the last "select" event because it didn't run in a synced
|
||||
// context.
|
||||
if(needs_select_ && last_select.valid()) {
|
||||
synced_context::run_and_throw(
|
||||
"fire_event", replay_helper::get_event(event_name_, event_hex, &last_select));
|
||||
} else {
|
||||
synced_context::run_in_synced_context_if_not_already(
|
||||
"fire_event", replay_helper::get_event(event_name_, event_hex, nullptr));
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes the implicit event handler for an inlined [command].
|
||||
*/
|
||||
void wml_menu_item::finish_handler() const
|
||||
{
|
||||
if ( !command_.empty() ) {
|
||||
if(!command_.empty()) {
|
||||
assert(resources::game_events);
|
||||
resources::game_events->remove_event_handler(command_["id"]);
|
||||
}
|
||||
|
||||
// Hotkey support
|
||||
if ( use_hotkey_ )
|
||||
if(use_hotkey_) {
|
||||
hotkey::remove_wml_hotkey(hotkey_id_);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes the implicit event handler for an inlined [command].
|
||||
*/
|
||||
void wml_menu_item::init_handler() const
|
||||
{
|
||||
// If this menu item has a [command], add a handler for it.
|
||||
if ( !command_.empty() ) {
|
||||
if(!command_.empty()) {
|
||||
assert(resources::game_events);
|
||||
resources::game_events->add_event_handler(command_, true);
|
||||
}
|
||||
|
||||
// Hotkey support
|
||||
if ( use_hotkey_ ) {
|
||||
if(use_hotkey_) {
|
||||
hotkey::add_wml_hotkey(hotkey_id_, description_, default_hotkey_);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Writes *this to the provided config.
|
||||
* This is the reverse of the constructor from a config and corresponds to
|
||||
* what will appear in [menu_item].
|
||||
*/
|
||||
void wml_menu_item::to_config(config & cfg) const
|
||||
void wml_menu_item::to_config(config& cfg) const
|
||||
{
|
||||
cfg["id"] = item_id_;
|
||||
cfg["image"] = image_;
|
||||
|
|
@ -273,106 +228,116 @@ void wml_menu_item::to_config(config & cfg) const
|
|||
cfg["needs_select"] = needs_select_;
|
||||
cfg["synced"] = is_synced_;
|
||||
|
||||
if ( use_hotkey_ && use_wml_menu_ )
|
||||
if(use_hotkey_ && use_wml_menu_) {
|
||||
cfg["use_hotkey"] = true;
|
||||
if ( use_hotkey_ && !use_wml_menu_ )
|
||||
}
|
||||
|
||||
if(use_hotkey_ && !use_wml_menu_) {
|
||||
cfg["use_hotkey"] = "only";
|
||||
if ( !use_hotkey_ && use_wml_menu_ )
|
||||
cfg["use_hotkey"] = false;
|
||||
if ( !use_hotkey_ && !use_wml_menu_ )
|
||||
{
|
||||
ERR_NG << "Bad data: wml_menu_item with both use_wml_menu and use_hotkey set to false is not supposed to be possible.";
|
||||
}
|
||||
|
||||
if(!use_hotkey_ && use_wml_menu_) {
|
||||
cfg["use_hotkey"] = false;
|
||||
}
|
||||
if ( !show_if_.empty() )
|
||||
|
||||
if(!use_hotkey_ && !use_wml_menu_) {
|
||||
ERR_NG << "Bad data: wml_menu_item with both use_wml_menu and use_hotkey set to false is not supposed to be "
|
||||
"possible.";
|
||||
cfg["use_hotkey"] = false;
|
||||
}
|
||||
|
||||
if(!show_if_.empty()) {
|
||||
cfg.add_child("show_if", show_if_.get_config());
|
||||
if ( !filter_location_.empty() )
|
||||
}
|
||||
|
||||
if(!filter_location_.empty()) {
|
||||
cfg.add_child("filter_location", filter_location_.get_config());
|
||||
if ( !command_.empty() )
|
||||
}
|
||||
|
||||
if(!command_.empty()) {
|
||||
cfg.add_child("command", command_);
|
||||
if ( !default_hotkey_.empty() )
|
||||
}
|
||||
|
||||
if(!default_hotkey_.empty()) {
|
||||
cfg.add_child("default_hotkey", default_hotkey_);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Updates *this based on @a vcfg.
|
||||
* This corresponds to what can appear in [set_menu_item].
|
||||
*/
|
||||
void wml_menu_item::update(const vconfig & vcfg)
|
||||
void wml_menu_item::update(const vconfig& vcfg)
|
||||
{
|
||||
const bool old_use_hotkey = use_hotkey_;
|
||||
// Tracks whether or not the hotkey has been updated.
|
||||
bool hotkey_updated = false;
|
||||
|
||||
if ( vcfg.has_attribute("image") )
|
||||
if(vcfg.has_attribute("image")) {
|
||||
image_ = vcfg["image"].str();
|
||||
}
|
||||
|
||||
if ( vcfg.has_attribute("description") ) {
|
||||
if(vcfg.has_attribute("description")) {
|
||||
description_ = vcfg["description"].t_str();
|
||||
hotkey_updated = true;
|
||||
}
|
||||
|
||||
if ( vcfg.has_attribute("needs_select") ) {
|
||||
if(vcfg.has_attribute("needs_select")) {
|
||||
ERR_NG << "needs_select= is deprecated\n";
|
||||
needs_select_ = vcfg["needs_select"].to_bool();
|
||||
}
|
||||
if ( vcfg.has_attribute("synced") )
|
||||
is_synced_ = vcfg["synced"].to_bool(true);
|
||||
|
||||
if ( const vconfig & child = vcfg.child("show_if") ) {
|
||||
if(vcfg.has_attribute("synced")) {
|
||||
is_synced_ = vcfg["synced"].to_bool(true);
|
||||
}
|
||||
|
||||
if(const vconfig& child = vcfg.child("show_if")) {
|
||||
show_if_ = child;
|
||||
show_if_.make_safe();
|
||||
}
|
||||
|
||||
if ( const vconfig & child = vcfg.child("filter_location") ) {
|
||||
if(const vconfig& child = vcfg.child("filter_location")) {
|
||||
filter_location_ = child;
|
||||
filter_location_.make_safe();
|
||||
}
|
||||
|
||||
if ( const vconfig & child = vcfg.child("default_hotkey") ) {
|
||||
if(const vconfig& child = vcfg.child("default_hotkey")) {
|
||||
default_hotkey_ = child.get_parsed_config();
|
||||
hotkey_updated = true;
|
||||
}
|
||||
|
||||
if ( vcfg.has_attribute("use_hotkey") ) {
|
||||
const config::attribute_value & use_hotkey_av = vcfg["use_hotkey"];
|
||||
if(vcfg.has_attribute("use_hotkey")) {
|
||||
const config::attribute_value& use_hotkey_av = vcfg["use_hotkey"];
|
||||
|
||||
use_hotkey_ = use_hotkey_av.to_bool(true);
|
||||
use_wml_menu_ = use_hotkey_av.str() != "only";
|
||||
}
|
||||
|
||||
if ( const vconfig & cmd = vcfg.child("command") ) {
|
||||
if(const vconfig& cmd = vcfg.child("command")) {
|
||||
const bool delayed = cmd["delayed_variable_substitution"].to_bool(true);
|
||||
update_command(delayed ? cmd.get_config() : cmd.get_parsed_config());
|
||||
}
|
||||
|
||||
|
||||
// Update the registered hotkey?
|
||||
|
||||
if ( use_hotkey_ && !old_use_hotkey )
|
||||
if(use_hotkey_ && !old_use_hotkey) {
|
||||
// The hotkey needs to be enabled.
|
||||
hotkey::add_wml_hotkey(hotkey_id_, description_, default_hotkey_);
|
||||
|
||||
else if ( use_hotkey_ && hotkey_updated )
|
||||
} else if(use_hotkey_ && hotkey_updated) {
|
||||
// The hotkey needs to be updated.
|
||||
hotkey::add_wml_hotkey(hotkey_id_, description_, default_hotkey_);
|
||||
|
||||
else if ( !use_hotkey_ && old_use_hotkey )
|
||||
} else if(!use_hotkey_ && old_use_hotkey) {
|
||||
// The hotkey needs to be disabled.
|
||||
hotkey::remove_wml_hotkey(hotkey_id_);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Updates our command to @a new_command.
|
||||
*/
|
||||
void wml_menu_item::update_command(const config & new_command)
|
||||
void wml_menu_item::update_command(const config& new_command)
|
||||
{
|
||||
// If there is an old command, remove it from the event handlers.
|
||||
if ( !command_.empty() ) {
|
||||
if(!command_.empty()) {
|
||||
assert(resources::game_events);
|
||||
manager::iteration iter(event_name_, *resources::game_events);
|
||||
while ( handler_ptr hand = *iter ) {
|
||||
if ( hand->is_menu_item() ) {
|
||||
while(handler_ptr hand = *iter) {
|
||||
if(hand->is_menu_item()) {
|
||||
LOG_NG << "Removing command for " << event_name_ << ".\n";
|
||||
resources::game_events->remove_event_handler(command_["id"].str());
|
||||
}
|
||||
|
|
@ -381,16 +346,17 @@ void wml_menu_item::update_command(const config & new_command)
|
|||
}
|
||||
|
||||
// Update our stored command.
|
||||
if ( new_command.empty() )
|
||||
if(new_command.empty()) {
|
||||
command_.clear();
|
||||
else {
|
||||
} else {
|
||||
command_ = new_command;
|
||||
|
||||
// Set some fields required by event processing.
|
||||
config::attribute_value & event_id = command_["id"];
|
||||
if ( event_id.empty() && !item_id_.empty() ) {
|
||||
config::attribute_value& event_id = command_["id"];
|
||||
if(event_id.empty() && !item_id_.empty()) {
|
||||
event_id = item_id_;
|
||||
}
|
||||
|
||||
command_["name"] = event_name_;
|
||||
command_["first_time_only"] = false;
|
||||
|
||||
|
|
@ -402,4 +368,3 @@ void wml_menu_item::update_command(const config & new_command)
|
|||
}
|
||||
|
||||
} // end namespace game_events
|
||||
|
||||
|
|
|
|||
|
|
@ -30,75 +30,160 @@ class unit_map;
|
|||
|
||||
namespace game_events
|
||||
{
|
||||
|
||||
class wml_menu_item
|
||||
{
|
||||
public:
|
||||
/// Constructor for when read from a saved config.
|
||||
wml_menu_item(const std::string& id, const config & cfg);
|
||||
/// Constructor for when defined in an event.
|
||||
wml_menu_item(const std::string& id, const vconfig & definition);
|
||||
/// Constructor for when modified by an event.
|
||||
wml_menu_item(const std::string& id, const vconfig & definition,
|
||||
const wml_menu_item & original);
|
||||
/**
|
||||
* Constructor for reading from a saved config.
|
||||
* This is the reverse of to_config() and corresponds to reading [menu_item].
|
||||
* Handlers are not initialized.
|
||||
*/
|
||||
wml_menu_item(const std::string& id, const config& cfg);
|
||||
|
||||
/// The id of this item.
|
||||
const std::string & id() const { return item_id_; }
|
||||
/// The image associated with this menu item.
|
||||
const std::string & image() const;
|
||||
/// If true, allow using the menu to trigger this item.
|
||||
bool use_wml_menu() const { return use_wml_menu_; }
|
||||
/**
|
||||
* Constructor for items defined in an event.
|
||||
* This is where default values are defined (the other constructors should have
|
||||
* all values to work with).
|
||||
* @param[in] id The id of the menu item.
|
||||
* @param[in] definition The WML defining this menu item.
|
||||
*/
|
||||
wml_menu_item(const std::string& id, const vconfig& definition);
|
||||
|
||||
/// Returns whether or not *this is applicable given the context.
|
||||
bool can_show(const map_location & hex, const game_data & data, filter_context & context) const;
|
||||
/// Causes the event associated with this item to fire.
|
||||
void fire_event(const map_location & event_hex, const game_data & data) const;
|
||||
/// Removes the implicit event handler for an inlined [command].
|
||||
/**
|
||||
* Constructor for items modified by an event.
|
||||
* (To avoid problems with a menu item's command changing itself, we make a
|
||||
* new menu item instead of modifying the existing one.)
|
||||
* @param[in] id The id of the menu item.
|
||||
* @param[in] definition The WML defining this menu item.
|
||||
* @param[in] original The previous version of the menu item with this id.
|
||||
*/
|
||||
wml_menu_item(const std::string& id, const vconfig& definition, const wml_menu_item& original);
|
||||
|
||||
/** The id of this item. */
|
||||
const std::string& id() const
|
||||
{
|
||||
return item_id_;
|
||||
}
|
||||
|
||||
/**
|
||||
* The image associated with this menu item.
|
||||
* The returned string will not be empty; a default will be supplied if needed.
|
||||
*/
|
||||
const std::string& image() const;
|
||||
|
||||
/** If true, allow using the menu to trigger this item. */
|
||||
bool use_wml_menu() const
|
||||
{
|
||||
return use_wml_menu_;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns whether or not *this is applicable given the context.
|
||||
* Assumes game variables x1, y1, and unit have been set.
|
||||
* @param[in] hex The hex where the menu will appear.
|
||||
*/
|
||||
bool can_show(const map_location& hex, const game_data& data, filter_context& context) const;
|
||||
|
||||
/**
|
||||
* Causes the event associated with this item to fire.
|
||||
* Also records the event.
|
||||
* This includes recording the previous select event, if applicable.
|
||||
* The undo stack will be cleared if the event mutated the gamestate.
|
||||
*
|
||||
* @param[in] event_hex The location of the event (where the menu was opened).
|
||||
* @param[in] last_select The location of the most recent "select" event.
|
||||
*/
|
||||
void fire_event(const map_location& event_hex, const game_data& data) const;
|
||||
|
||||
/** Removes the implicit event handler for an inlined [command]. */
|
||||
void finish_handler() const;
|
||||
/// Initializes the implicit event handler for an inlined [command].
|
||||
void init_handler() const;
|
||||
/// The text to put in a menu for this item.
|
||||
/// This will be either translated text or a hotkey identifier.
|
||||
std::string menu_text() const
|
||||
{ return use_hotkey_ ? hotkey_id_ : description_.str() + ' '; } // The space is to prevent accidental hotkey binding.
|
||||
/// Writes *this to the provided config.
|
||||
void to_config(config & cfg) const;
|
||||
bool is_synced() const { return is_synced_; }
|
||||
private: // Functions
|
||||
/// Updates *this based on @a vcfg.
|
||||
void update(const vconfig & vcfg);
|
||||
/// Updates our command to @a new_command.
|
||||
void update_command(const config & new_command);
|
||||
|
||||
private: // Data
|
||||
/// The id of this menu item.
|
||||
/** Initializes the implicit event handler for an inlined [command]. */
|
||||
void init_handler() const;
|
||||
|
||||
/**
|
||||
* The text to put in a menu for this item.
|
||||
* This will be either translated text or a hotkey identifier.
|
||||
*/
|
||||
std::string menu_text() const
|
||||
{
|
||||
// The space is to prevent accidental hotkey binding.
|
||||
return use_hotkey_ ? hotkey_id_ : description_.str() + ' ';
|
||||
}
|
||||
|
||||
/**
|
||||
* Writes *this to the provided config.
|
||||
* This is the reverse of the constructor from a config and corresponds to
|
||||
* what will appear in [menu_item].
|
||||
*/
|
||||
void to_config(config& cfg) const;
|
||||
|
||||
bool is_synced() const
|
||||
{
|
||||
return is_synced_;
|
||||
}
|
||||
|
||||
private:
|
||||
/**
|
||||
* Updates *this based on @a vcfg.
|
||||
* This corresponds to what can appear in [set_menu_item].
|
||||
*/
|
||||
void update(const vconfig& vcfg);
|
||||
|
||||
/** Updates our command to @a new_command. */
|
||||
void update_command(const config& new_command);
|
||||
|
||||
private:
|
||||
/** The id of this menu item. */
|
||||
const std::string item_id_;
|
||||
/// The name of this item's event(s); based on the item's id.
|
||||
|
||||
/** The name of this item's event(s); based on the item's id. */
|
||||
const std::string event_name_;
|
||||
/// The id for this item's hotkey; based on the item's id.
|
||||
|
||||
/** The id for this item's hotkey; based on the item's id. */
|
||||
const std::string hotkey_id_;
|
||||
/// The image to display in the menu next to this item's description.
|
||||
|
||||
/** The image to display in the menu next to this item's description. */
|
||||
std::string image_;
|
||||
/// The text to display in the menu for this item.
|
||||
|
||||
/** The text to display in the menu for this item. */
|
||||
t_string description_;
|
||||
/// Whether or not this event says it makes use of the last selected unit.
|
||||
|
||||
/** Whether or not this event says it makes use of the last selected unit. */
|
||||
bool needs_select_;
|
||||
/// A condition that must hold in order for this menu item to be visible.
|
||||
/// (An empty condition always holds.)
|
||||
vconfig show_if_; // When used, we need a vconfig instead of a config.
|
||||
/// A location filter to be applied to the hex where the menu is invoked.
|
||||
/// (An empty filter always passes.)
|
||||
vconfig filter_location_; // When used, we need a vconfig instead of a config.
|
||||
/// Actions to take when this item is chosen.
|
||||
|
||||
/**
|
||||
* A condition that must hold in order for this menu item to be visible.
|
||||
* (An empty condition always holds.)
|
||||
*
|
||||
* When used, we need a vconfig instead of a config.
|
||||
*/
|
||||
vconfig show_if_;
|
||||
|
||||
/**
|
||||
* A location filter to be applied to the hex where the menu is invoked.
|
||||
* (An empty filter always passes.)
|
||||
*
|
||||
* When used, we need a vconfig instead of a config.
|
||||
*/
|
||||
vconfig filter_location_;
|
||||
|
||||
/** Actions to take when this item is chosen. */
|
||||
config command_;
|
||||
/// Config object containing the default hotkey.
|
||||
|
||||
/** Config object containing the default hotkey. */
|
||||
config default_hotkey_;
|
||||
/// If true, allow using a hotkey to trigger this item.
|
||||
|
||||
/** If true, allow using a hotkey to trigger this item. */
|
||||
bool use_hotkey_;
|
||||
/// If true, allow using the menu to trigger this item.
|
||||
|
||||
/** If true, allow using the menu to trigger this item. */
|
||||
bool use_wml_menu_;
|
||||
/// If true, this item will be sended ot ther clients.
|
||||
/// The command shall not change the gamestate if !is_synced_
|
||||
|
||||
/**
|
||||
* If true, this item will be sended ot ther clients.
|
||||
* The command shall not change the gamestate if !is_synced_
|
||||
*/
|
||||
bool is_synced_;
|
||||
};
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue