vcmi/luascript/api/library/Bonus.h

/*
 * Bonus.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 "../../LuaWrapper.h"
#include "../MethodRegistrar.h"
#include "../../../lib/bonuses/Bonus.h"
#include "../../../lib/bonuses/BonusList.h"
#include "../../../lib/bonuses/BonusEnum.h"

VCMI_LIB_NAMESPACE_BEGIN

namespace scripting::api
{

class BonusProxy : public CopyableWrapper<Bonus, BonusProxy>
{
public:
	static constexpr std::string_view luaName = "Bonus";
	static constexpr std::string_view luaDescription =
		"A single effect contributing to target abilities (e.g. +5 attack, "
		"immunity to fire spells). Carries type, value, source, duration, stacking key. "
		"Scripts read bonuses through `getBonuses(...)` and construct new ones via "
		"addUnitBonus or addBattleBonus in ServerCallback.";

	static void registerMethods(MethodRegistrar & R);

	static std::string getType(const Bonus & b);
	static si32 getVal(const Bonus & b);
	static std::string getSubtype(const Bonus & b);
	static std::string getSourceID(const Bonus & b);
	static BonusSource getSource(const Bonus & b);
	static std::vector<BonusDuration::BonusDuration> getDuration(const Bonus & b);
	static BonusValueType getValType(const Bonus & b);
	static std::string getStacking(const Bonus & b);
	static si16 getTurnsRemain(const Bonus & b);
	static bool isHidden(const Bonus & b);
	static si32 getParametersAsNumber(const Bonus & b);
};

class BonusListProxy : public CopyableWrapper<BonusList, BonusListProxy>
{
public:
	static constexpr std::string_view luaName = "BonusList";
	static constexpr std::string_view luaDescription =
		"A collection of Bonus values returned by `getBonuses(...)`. Use `size()` and "
		"`getBonus(index)` to iterate. A copy of the engine's internal list at the moment of "
		"the call — changes to holder afterwards will not affect this snapshot.";

	static void registerMethods(MethodRegistrar & R);

	static int32_t size(const BonusList & list);
	static Bonus getBonus(const BonusList & list, int32_t index);
};

}

VCMI_LIB_NAMESPACE_END