xref: /dports/games/solarus/solarus-f43727b232b3ed13d98440a845e2a29e470e4f0d/src/core/CommandsEffects.cpp

/*
 * Copyright (C) 2006-2019 Christopho, Solarus - http://www.solarus-games.org
 *
 * Solarus is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Solarus is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program. If not, see <http://www.gnu.org/licenses/>.
 */
#include "solarus/core/CommandsEffects.h"
#include <iostream>

namespace Solarus {

const std::string EnumInfoTraits<CommandsEffects::ActionKeyEffect>::pretty_name = "action key effect";

/**
 * \brief Lua name of each value of the ActionKeyEffect enum.
 */
const EnumInfo<CommandsEffects::ActionKeyEffect>::names_type EnumInfoTraits<CommandsEffects::ActionKeyEffect>::names = {
  { CommandsEffects::ACTION_KEY_NONE, "" },
  { CommandsEffects::ACTION_KEY_NEXT, "next" },
  { CommandsEffects::ACTION_KEY_LOOK, "look" },
  { CommandsEffects::ACTION_KEY_OPEN, "open" },
  { CommandsEffects::ACTION_KEY_LIFT, "lift" },
  { CommandsEffects::ACTION_KEY_THROW, "throw" },
  { CommandsEffects::ACTION_KEY_GRAB, "grab" },
  { CommandsEffects::ACTION_KEY_SPEAK, "speak" },
  { CommandsEffects::ACTION_KEY_SWIM, "swim"}
};

const std::string EnumInfoTraits<CommandsEffects::AttackKeyEffect>::pretty_name = "sword key effect";

/**
 * \brief Lua name of each value of the SwordKeyEffect enum.
 */
const EnumInfo<CommandsEffects::AttackKeyEffect>::names_type EnumInfoTraits<CommandsEffects::AttackKeyEffect>::names = {
  { CommandsEffects::ATTACK_KEY_NONE, "" },
  { CommandsEffects::ATTACK_KEY_SWORD, "sword" }
};

const std::string EnumInfoTraits<CommandsEffects::PauseKeyEffect>::pretty_name = "pause key effect";

/**
 * \brief Lua name of each value of the PauseKeyEffect enum.
 */
const EnumInfo<CommandsEffects::PauseKeyEffect>::names_type EnumInfoTraits<CommandsEffects::PauseKeyEffect>::names = {
  { CommandsEffects::PAUSE_KEY_NONE, "" },
  { CommandsEffects::PAUSE_KEY_PAUSE, "pause" },
  { CommandsEffects::PAUSE_KEY_RETURN, "return" }
};

/**
 * \brief Constructor.
 */
CommandsEffects::CommandsEffects():
  action_key_effect(ACTION_KEY_NONE),
  action_key_effects_saved(),
  action_key_enabled(true),
  sword_key_effect(ATTACK_KEY_NONE),
  sword_key_effects_saved(),
  sword_key_enabled(true),
  pause_key_effect(PAUSE_KEY_PAUSE),
  pause_key_effects_saved(),
  pause_key_enabled(true),
  item_keys_enabled(true) {

}

// action key

/**
 * \brief Returns the current effect of the action key.
 * \return the current effect of the action key
 */
CommandsEffects::ActionKeyEffect CommandsEffects::get_action_key_effect() {
  return action_key_effect;
}
/**
 * \brief Sets the current effect of the action key.
 * \param action_key_effect the current effect of the action key
 */
void CommandsEffects::set_action_key_effect(CommandsEffects::ActionKeyEffect action_key_effect) {
  this->action_key_effect = action_key_effect;
}

/**
 * \brief Returns whether the action key is enabled.
 * \return true if the action key is enabled, false otherwise
 */
bool CommandsEffects::is_action_key_enabled() {
  return action_key_enabled;
}

/**
 * \brief Sets whether the action key is enabled.
 * \param enable true to enable the action key, false to disable it
 */
void CommandsEffects::set_action_key_enabled(bool enable) {
  this->action_key_enabled = enable;
}

/**
 * \brief Saves the current effect of the action key.
 *
 * Call restore_action_key_effect() to restore the action key saved here.
 */
void CommandsEffects::save_action_key_effect() {
  action_key_effects_saved.push(get_action_key_effect());
}

/**
 * \brief Restores the action key effect saved by the last
 * call to save_action_key_effect().
 */
void CommandsEffects::restore_action_key_effect() {
  if (!action_key_effects_saved.empty()) {
    action_key_effect = action_key_effects_saved.top();
    action_key_effects_saved.pop();
  }
}

/**
 * \brief Returns whether the action key is currently taking effect
 * on the entity the hero is facing.
 *
 * Such action key effects are ACTION_KEY_LOOK, ACTION_KEY_OPEN,
 * ACTION_KEY_LIFT, ACTION_KEY_SPEAK and ACTION_KEY_GRAB.
 *
 * \return true if the action key is acting on the facing entity
 */
bool CommandsEffects::is_action_key_acting_on_facing_entity() {
  return action_key_effect == ACTION_KEY_LOOK
    || action_key_effect == ACTION_KEY_OPEN
    || action_key_effect == ACTION_KEY_LIFT
    || action_key_effect == ACTION_KEY_SPEAK
    || action_key_effect == ACTION_KEY_GRAB;
}

// sword key

/**
 * \brief Returns the current effect of the sword key.
 * \return the current effect of the sword key
 */
CommandsEffects::AttackKeyEffect CommandsEffects::get_sword_key_effect() {
  return sword_key_effect;
}

/**
 * \brief Sets the current effect of the sword key.
 * \param sword_key_effect the current effect of the sword key
 */
void CommandsEffects::set_sword_key_effect(CommandsEffects::AttackKeyEffect sword_key_effect) {
  this->sword_key_effect = sword_key_effect;
}

/**
 * \brief Returns whether the sword key is enabled.
 * \return true if the sword key is enabled, false otherwise
 */
bool CommandsEffects::is_sword_key_enabled() {
  return sword_key_enabled;
}

/**
 * \brief Sets whether the sword key is enabled.
 * \param enable true to enable the sword key, false to disable it
 */
void CommandsEffects::set_sword_key_enabled(bool enable) {
  this->sword_key_enabled = enable;
}

/**
 * \brief Saves the current effect of the sword key.
 *
 * Call restore_sword_key_effect to restore the sword key saved here.
 */
void CommandsEffects::save_sword_key_effect() {
  sword_key_effects_saved.push(get_sword_key_effect());
}

/**
 * \brief Restores the sword key effect saved by the last
 * call to save_sword_key_effect().
 */
void CommandsEffects::restore_sword_key_effect() {
  if (!sword_key_effects_saved.empty()) {
    sword_key_effect = sword_key_effects_saved.top();
    sword_key_effects_saved.pop();
  }
}

// pause key

/**
 * \brief Returns the current effect of the pause key.
 * \return the current effect of the pause key
 */
CommandsEffects::PauseKeyEffect CommandsEffects::get_pause_key_effect() {
  return pause_key_effect;
}

/**
 * \brief Sets the current effect of the pause key.
 * \param pause_key_effect the current effect of the pause key
 */
void CommandsEffects::set_pause_key_effect(CommandsEffects::PauseKeyEffect pause_key_effect) {
  this->pause_key_effect = pause_key_effect;
}

/**
 * \brief Returns whether the pause key is enabled.
 * \return true if the pause key is enabled, false otherwise
 */
bool CommandsEffects::is_pause_key_enabled() {
  return pause_key_enabled;
}

/**
 * \brief Sets whether the pause key is enabled.
 * \param enable true to enable the pause key, false to disable it
 */
void CommandsEffects::set_pause_key_enabled(bool enable) {
  this->pause_key_enabled = enable;
}

/**
 * \brief Saves the current effect of the pause key.
 *
 * Call restore_pause_key_effect to restore the pause key saved here.
 */
void CommandsEffects::save_pause_key_effect() {
  pause_key_effects_saved.push(get_pause_key_effect());
}

/**
 * \brief Restores the pause key effect saved by the last
 * call to save_pause_key_effect().
 */
void CommandsEffects::restore_pause_key_effect() {
  if (!pause_key_effects_saved.empty()) {
    pause_key_effect = pause_key_effects_saved.top();
    pause_key_effects_saved.pop();
  }
}

// item keys

/**
 * \brief Returns whether the two item keys are enabled.
 * \return true if the two item keys are enabled, false otherwise
 */
bool CommandsEffects::are_item_keys_enabled() {
  return item_keys_enabled;
}

/**
 * \brief Sets whether the two item keys are enabled.
 * \param enable true to enable the two item keys, false to disable them
 */
void CommandsEffects::set_item_keys_enabled(bool enable) {
  this->item_keys_enabled = enable;
}

/**
 * \brief Enables or disables the 5 keys.
 * \param enable true to enable the 5 keys, false to disable them
 */
void CommandsEffects::set_all_keys_enabled(bool enable) {
  set_action_key_enabled(enable);
  set_sword_key_enabled(enable);
  set_pause_key_enabled(enable);
  set_item_keys_enabled(enable);
}

}