/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * This program 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.
 *
 * This program 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/>.
 *
 */

#ifndef ULTIMA_SHARED_ACTIONS_ACTION_H
#define ULTIMA_SHARED_ACTIONS_ACTION_H

#include "ultima/shared/core/tree_item.h"

namespace Ultima {
namespace Shared {

class Game;

namespace Maps {
class Map;
}

namespace Actions {

/**
 * Base class for implementing the various actions the player can do, such as moving, climbing, entering, etc.
 */
class Action : public TreeItem {
protected:
	/**
	 * Signals the end of the turn
	 */
	void endOfTurn();
public:
	/**
	 * Constructor
	 */
	Action(TreeItem *parent);

	/**
	 * Destructor
	 */
	~Action() override {}

	/**
	 * Jumps up through the parents to find the root game
	 */
	Game *getGame();

	/**
	 * Return the game's map
	 */
	Maps::Map *getMap();

	/**
	 * Adds a text string to the info area
	 * @param text			Text to add
	 * @param newLine		Whether to apply a newline at the end
	 */
	void addInfoMsg(const Common::String &text, bool newLine = true, bool replaceLine = false);

	/**
	 * Play a sound effect
	 */
	void playFX(uint effectId);
};

} // End of namespace Actions
} // End of namespace Shared
} // End of namespace Ultima

#endif