mirror of
https://github.com/vcmi/vcmi.git
synced 2024-12-26 22:57:00 +02:00
46 lines
1.3 KiB
C++
46 lines
1.3 KiB
C++
/*
|
|
* CCallbackBase.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 "../GameConstants.h"
|
|
|
|
#define RETURN_IF_NOT_BATTLE(...) if(!duringBattle()) {logGlobal->error("%s called when no battle!", __FUNCTION__); return __VA_ARGS__; }
|
|
#define ASSERT_IF_CALLED_WITH_PLAYER if(!player) {logGlobal->error(BOOST_CURRENT_FUNCTION); assert(0);}
|
|
|
|
VCMI_LIB_NAMESPACE_BEGIN
|
|
|
|
class IBattleInfo;
|
|
class BattleInfo;
|
|
class CBattleInfoEssentials;
|
|
|
|
|
|
//Basic class for various callbacks (interfaces called by players to get info about game and so forth)
|
|
class DLL_LINKAGE CCallbackBase
|
|
{
|
|
const IBattleInfo * battle = nullptr; //battle to which the player is engaged, nullptr if none or not applicable
|
|
|
|
protected:
|
|
std::optional<PlayerColor> player; // not set gives access to all information, otherwise callback provides only information "visible" for player
|
|
|
|
CCallbackBase(std::optional<PlayerColor> Player);
|
|
CCallbackBase() = default;
|
|
|
|
const IBattleInfo * getBattle() const;
|
|
void setBattle(const IBattleInfo * B);
|
|
bool duringBattle() const;
|
|
|
|
public:
|
|
std::optional<PlayerColor> getPlayerID() const;
|
|
|
|
friend class CBattleInfoEssentials;
|
|
};
|
|
|
|
|
|
VCMI_LIB_NAMESPACE_END
|