vcmi/client/HeroMovementController.h

/*
 * CPlayerInterface.h, part of VCMI engine
 *
 * Authors: listed in file AUTHORS in main folder
 *
 * License: GNU General Public License v2.0 or later
 * Full text of license available in license.txt file, in main folder
 *
 */
#pragma once

#include "../lib/constants/EntityIdentifiers.h"
#include "../lib/int3.h"
#include "../lib/filesystem/ResourcePath.h"

VCMI_LIB_NAMESPACE_BEGIN
using TTeleportExitsList = std::vector<std::pair<ObjectInstanceID, int3>>;

class CGHeroInstance;
class CArmedInstance;
struct CGPathNode;

struct CGPath;
struct TryMoveHero;
enum class EPathNodeAction : ui8;
VCMI_LIB_NAMESPACE_END

class HeroMovementController
{
	/// there is an ongoing movement loop, in one or another stage
	bool duringMovement = false;
	/// movement was requested to be terminated, e.g. by player or due to inability to move
	bool stoppingMovement = false;

	const CGHeroInstance * currentlyMovingHero = nullptr;
	AudioPath currentMovementSoundName;
	int currentMovementSoundChannel = -1;

	/// return final node in a path, if exists
	std::optional<int3> getLastTile(const CGHeroInstance * h) const;
	/// return first path in a path, if exists
	std::optional<int3> getNextTile(const CGHeroInstance * h) const;

	bool canHeroStopAtNode(const CGPathNode & node) const;

	void updatePath(const CGHeroInstance * hero, const TryMoveHero & details);

	/// Moves hero 1 tile / path node
	void moveHeroOnce(const CGHeroInstance * h, const CGPath & path);

	void endHeroMove(const CGHeroInstance * h);

	AudioPath getMovementSoundFor(const CGHeroInstance * hero, int3 posPrev, int3 posNext, EPathNodeAction moveType);
	void updateMovementSound(const CGHeroInstance * hero, int3 posPrev, int3 posNext, EPathNodeAction moveType);
	void stopMovementSound();

public:
	// const queries
	bool isHeroMovingThroughGarrison(const CGHeroInstance * hero, const CArmedInstance * garrison) const;
	bool isHeroMoving() const;

	// netpack handlers
	void onMoveHeroApplied();
	void onPlayerTurnStarted();
	void onBattleStarted();
	void showTeleportDialog(const CGHeroInstance * hero, TeleportChannelID channel, TTeleportExitsList exits, bool impassable, QueryID askID);
	void heroMoved(const CGHeroInstance * hero, const TryMoveHero & details);

	// UI handlers
	void movementStartRequested(const CGHeroInstance * h, const CGPath & path);
	void movementAbortRequested();
};