951 lines
44 KiB
C++
951 lines
44 KiB
C++
#include "magicbindings.hpp"
|
|
|
|
#include <format>
|
|
|
|
#include <components/esm3/activespells.hpp>
|
|
#include <components/esm3/loadalch.hpp>
|
|
#include <components/esm3/loadarmo.hpp>
|
|
#include <components/esm3/loadbook.hpp>
|
|
#include <components/esm3/loadclot.hpp>
|
|
#include <components/esm3/loadench.hpp>
|
|
#include <components/esm3/loadingr.hpp>
|
|
#include <components/esm3/loadmgef.hpp>
|
|
#include <components/esm3/loadspel.hpp>
|
|
#include <components/esm3/loadweap.hpp>
|
|
#include <components/lua/luastate.hpp>
|
|
#include <components/lua/util.hpp>
|
|
#include <components/misc/color.hpp>
|
|
#include <components/misc/resourcehelpers.hpp>
|
|
#include <components/resource/resourcesystem.hpp>
|
|
|
|
#include "../mwbase/environment.hpp"
|
|
#include "../mwbase/mechanicsmanager.hpp"
|
|
#include "../mwbase/windowmanager.hpp"
|
|
#include "../mwbase/world.hpp"
|
|
#include "../mwmechanics/activespells.hpp"
|
|
#include "../mwmechanics/actorutil.hpp"
|
|
#include "../mwmechanics/creaturestats.hpp"
|
|
#include "../mwmechanics/magiceffects.hpp"
|
|
#include "../mwmechanics/spellutil.hpp"
|
|
#include "../mwworld/class.hpp"
|
|
#include "../mwworld/datetimemanager.hpp"
|
|
#include "../mwworld/esmstore.hpp"
|
|
#include "../mwworld/inventorystore.hpp"
|
|
#include "../mwworld/worldmodel.hpp"
|
|
|
|
#include "localscripts.hpp"
|
|
#include "luamanagerimp.hpp"
|
|
#include "magictypebindings.hpp"
|
|
#include "object.hpp"
|
|
#include "objectvariant.hpp"
|
|
#include "recordstore.hpp"
|
|
|
|
namespace MWLua
|
|
{
|
|
template <typename Store>
|
|
struct ActorStore
|
|
{
|
|
using Collection = typename Store::Collection;
|
|
using Iterator = typename Collection::const_iterator;
|
|
|
|
ActorStore(const sol::object& actor)
|
|
: mActor(actor)
|
|
, mIterator()
|
|
, mIndex(0)
|
|
{
|
|
if (!isActor())
|
|
throw std::runtime_error("Actor expected");
|
|
reset();
|
|
}
|
|
|
|
bool isActor() const { return !mActor.ptr().isEmpty() && mActor.ptr().getClass().isActor(); }
|
|
|
|
bool isLObject() const { return mActor.isLObject(); }
|
|
|
|
void reset()
|
|
{
|
|
mIndex = 0;
|
|
auto* store = getStore();
|
|
if (store)
|
|
mIterator = store->begin();
|
|
}
|
|
|
|
bool isEnd() const
|
|
{
|
|
auto* store = getStore();
|
|
if (store)
|
|
return mIterator == store->end();
|
|
return true;
|
|
}
|
|
|
|
void advance()
|
|
{
|
|
auto* store = getStore();
|
|
if (store)
|
|
{
|
|
mIterator++;
|
|
mIndex++;
|
|
}
|
|
}
|
|
|
|
Store* getStore() const;
|
|
|
|
ObjectVariant mActor;
|
|
Iterator mIterator;
|
|
int mIndex;
|
|
};
|
|
|
|
template <>
|
|
MWMechanics::Spells* ActorStore<MWMechanics::Spells>::getStore() const
|
|
{
|
|
if (!isActor())
|
|
return nullptr;
|
|
const MWWorld::Ptr& ptr = mActor.ptr();
|
|
return &ptr.getClass().getCreatureStats(ptr).getSpells();
|
|
}
|
|
|
|
template <>
|
|
MWMechanics::MagicEffects* ActorStore<MWMechanics::MagicEffects>::getStore() const
|
|
{
|
|
if (!isActor())
|
|
return nullptr;
|
|
const MWWorld::Ptr& ptr = mActor.ptr();
|
|
return &ptr.getClass().getCreatureStats(ptr).getMagicEffects();
|
|
}
|
|
|
|
template <>
|
|
MWMechanics::ActiveSpells* ActorStore<MWMechanics::ActiveSpells>::getStore() const
|
|
{
|
|
if (!isActor())
|
|
return nullptr;
|
|
const MWWorld::Ptr& ptr = mActor.ptr();
|
|
return &ptr.getClass().getCreatureStats(ptr).getActiveSpells();
|
|
}
|
|
|
|
struct ActiveEffect
|
|
{
|
|
MWMechanics::EffectKey key;
|
|
MWMechanics::EffectParam param;
|
|
};
|
|
struct ActiveSpell
|
|
{
|
|
ObjectVariant mActor;
|
|
MWMechanics::ActiveSpells::ActiveSpellParams mParams;
|
|
};
|
|
|
|
// class returned via 'types.Actor.spells(obj)' in Lua
|
|
using ActorSpells = ActorStore<MWMechanics::Spells>;
|
|
// class returned via 'types.Actor.activeEffects(obj)' in Lua
|
|
using ActorActiveEffects = ActorStore<MWMechanics::MagicEffects>;
|
|
// class returned via 'types.Actor.activeSpells(obj)' in Lua
|
|
using ActorActiveSpells = ActorStore<MWMechanics::ActiveSpells>;
|
|
}
|
|
|
|
namespace sol
|
|
{
|
|
template <typename T>
|
|
struct is_automagical<MWLua::ActorStore<T>> : std::false_type
|
|
{
|
|
};
|
|
template <>
|
|
struct is_automagical<MWLua::ActiveSpell> : std::false_type
|
|
{
|
|
};
|
|
}
|
|
|
|
namespace MWLua
|
|
{
|
|
static ESM::RefId toSpellId(const sol::object& spellOrId)
|
|
{
|
|
if (spellOrId.is<ESM::Spell>())
|
|
return spellOrId.as<const ESM::Spell*>()->mId;
|
|
else
|
|
return ESM::RefId::deserializeText(LuaUtil::cast<std::string_view>(spellOrId));
|
|
}
|
|
static ESM::RefId toRecordId(const sol::object& recordOrId)
|
|
{
|
|
if (recordOrId.is<ESM::Spell>())
|
|
return recordOrId.as<const ESM::Spell*>()->mId;
|
|
else if (recordOrId.is<ESM::Potion>())
|
|
return recordOrId.as<const ESM::Potion*>()->mId;
|
|
else if (recordOrId.is<ESM::Ingredient>())
|
|
return recordOrId.as<const ESM::Ingredient*>()->mId;
|
|
else if (recordOrId.is<ESM::Enchantment>())
|
|
return recordOrId.as<const ESM::Enchantment*>()->mId;
|
|
else if (recordOrId.is<ESM::Armor>())
|
|
return recordOrId.as<const ESM::Armor*>()->mId;
|
|
else if (recordOrId.is<ESM::Book>())
|
|
return recordOrId.as<const ESM::Book*>()->mId;
|
|
else if (recordOrId.is<ESM::Clothing>())
|
|
return recordOrId.as<const ESM::Clothing*>()->mId;
|
|
else if (recordOrId.is<ESM::Weapon>())
|
|
return recordOrId.as<const ESM::Weapon*>()->mId;
|
|
else
|
|
return ESM::RefId::deserializeText(LuaUtil::cast<std::string_view>(recordOrId));
|
|
}
|
|
|
|
static const ESM::Spell* toSpell(const sol::object& spellOrId)
|
|
{
|
|
if (spellOrId.is<ESM::Spell>())
|
|
return spellOrId.as<const ESM::Spell*>();
|
|
else
|
|
{
|
|
auto& store = MWBase::Environment::get().getWorld()->getStore();
|
|
auto refId = ESM::RefId::deserializeText(LuaUtil::cast<std::string_view>(spellOrId));
|
|
return store.get<ESM::Spell>().find(refId);
|
|
}
|
|
}
|
|
|
|
sol::table initCoreMagicBindings(const Context& context)
|
|
{
|
|
sol::state_view state = context.sol();
|
|
sol::table magicApi(state, sol::create);
|
|
|
|
// Constants
|
|
magicApi["RANGE"] = LuaUtil::makeStrictReadOnly(LuaUtil::tableFromPairs<std::string_view, ESM::RangeType>(state,
|
|
{
|
|
{ "Self", ESM::RT_Self },
|
|
{ "Touch", ESM::RT_Touch },
|
|
{ "Target", ESM::RT_Target },
|
|
}));
|
|
magicApi["SPELL_TYPE"]
|
|
= LuaUtil::makeStrictReadOnly(LuaUtil::tableFromPairs<std::string_view, ESM::Spell::SpellType>(state,
|
|
{
|
|
{ "Spell", ESM::Spell::ST_Spell },
|
|
{ "Ability", ESM::Spell::ST_Ability },
|
|
{ "Blight", ESM::Spell::ST_Blight },
|
|
{ "Disease", ESM::Spell::ST_Disease },
|
|
{ "Curse", ESM::Spell::ST_Curse },
|
|
{ "Power", ESM::Spell::ST_Power },
|
|
}));
|
|
magicApi["ENCHANTMENT_TYPE"]
|
|
= LuaUtil::makeStrictReadOnly(LuaUtil::tableFromPairs<std::string_view, ESM::Enchantment::Type>(state,
|
|
{
|
|
{ "CastOnce", ESM::Enchantment::Type::CastOnce },
|
|
{ "CastOnStrike", ESM::Enchantment::Type::WhenStrikes },
|
|
{ "CastOnUse", ESM::Enchantment::Type::WhenUsed },
|
|
{ "ConstantEffect", ESM::Enchantment::Type::ConstantEffect },
|
|
}));
|
|
|
|
sol::table effect(state, sol::create);
|
|
magicApi["EFFECT_TYPE"] = LuaUtil::makeStrictReadOnly(effect);
|
|
for (int i = 0; i < ESM::MagicEffect::Length; ++i)
|
|
{
|
|
std::string_view name = ESM::MagicEffect::indexToName(i);
|
|
effect[name] = ESM::MagicEffect::indexToRefId(i).serializeText();
|
|
}
|
|
|
|
// Spell store
|
|
sol::table spells(state, sol::create);
|
|
addRecordFunctionBinding<ESM::Spell>(spells, context);
|
|
spells["createRecordDraft"] = tableToSpell;
|
|
magicApi["spells"] = LuaUtil::makeReadOnly(spells);
|
|
|
|
// Enchantment store
|
|
sol::table enchantments(state, sol::create);
|
|
addRecordFunctionBinding<ESM::Enchantment>(enchantments, context);
|
|
enchantments["createRecordDraft"] = tableToEnchantment;
|
|
magicApi["enchantments"] = LuaUtil::makeReadOnly(enchantments);
|
|
|
|
// MagicEffect store
|
|
sol::table magicEffects(state, sol::create);
|
|
addRecordFunctionBinding<ESM::MagicEffect>(magicEffects, context);
|
|
magicApi["effects"] = LuaUtil::makeReadOnly(magicEffects);
|
|
const auto* magicEffectStore = &MWBase::Environment::get().getWorld()->getStore().get<ESM::MagicEffect>();
|
|
|
|
// Spell record
|
|
addSpellBindings(state);
|
|
|
|
// Enchantment record
|
|
addEnchantmentBindings(state);
|
|
|
|
// Effect params
|
|
addEffectParamsBindings(state);
|
|
|
|
// MagicEffect record
|
|
addMagicEffectType(state);
|
|
|
|
auto activeSpellEffectT = state.new_usertype<ESM::ActiveEffect>("ActiveSpellEffect");
|
|
activeSpellEffectT[sol::meta_function::to_string] = [](const ESM::ActiveEffect& self) {
|
|
return std::format("ActiveSpellEffect[{}]", self.mEffectId.toDebugString());
|
|
};
|
|
activeSpellEffectT["id"]
|
|
= sol::readonly_property([](const ESM::ActiveEffect& self) -> ESM::RefId { return self.mEffectId; });
|
|
activeSpellEffectT["index"]
|
|
= sol::readonly_property([](const ESM::ActiveEffect& self) -> int { return self.mEffectIndex; });
|
|
activeSpellEffectT["name"] = sol::readonly_property([](const ESM::ActiveEffect& self) -> std::string {
|
|
return MWMechanics::EffectKey(self.mEffectId, self.getSkillOrAttribute()).toString();
|
|
});
|
|
activeSpellEffectT["affectedSkill"]
|
|
= sol::readonly_property([magicEffectStore](const ESM::ActiveEffect& self) -> sol::optional<std::string> {
|
|
auto* rec = magicEffectStore->find(self.mEffectId);
|
|
if (rec->mData.mFlags & ESM::MagicEffect::TargetSkill)
|
|
return self.getSkillOrAttribute().serializeText();
|
|
else
|
|
return sol::nullopt;
|
|
});
|
|
activeSpellEffectT["affectedAttribute"]
|
|
= sol::readonly_property([magicEffectStore](const ESM::ActiveEffect& self) -> sol::optional<std::string> {
|
|
auto* rec = magicEffectStore->find(self.mEffectId);
|
|
if (rec->mData.mFlags & ESM::MagicEffect::TargetAttribute)
|
|
return self.getSkillOrAttribute().serializeText();
|
|
else
|
|
return sol::nullopt;
|
|
});
|
|
activeSpellEffectT["magnitudeThisFrame"]
|
|
= sol::readonly_property([magicEffectStore](const ESM::ActiveEffect& self) -> sol::optional<float> {
|
|
auto* rec = magicEffectStore->find(self.mEffectId);
|
|
if (rec->mData.mFlags & ESM::MagicEffect::Flags::NoMagnitude)
|
|
return sol::nullopt;
|
|
return self.mMagnitude;
|
|
});
|
|
activeSpellEffectT["minMagnitude"]
|
|
= sol::readonly_property([magicEffectStore](const ESM::ActiveEffect& self) -> sol::optional<float> {
|
|
auto* rec = magicEffectStore->find(self.mEffectId);
|
|
if (rec->mData.mFlags & ESM::MagicEffect::Flags::NoMagnitude)
|
|
return sol::nullopt;
|
|
return self.mMinMagnitude;
|
|
});
|
|
activeSpellEffectT["maxMagnitude"]
|
|
= sol::readonly_property([magicEffectStore](const ESM::ActiveEffect& self) -> sol::optional<float> {
|
|
auto* rec = magicEffectStore->find(self.mEffectId);
|
|
if (rec->mData.mFlags & ESM::MagicEffect::Flags::NoMagnitude)
|
|
return sol::nullopt;
|
|
return self.mMaxMagnitude;
|
|
});
|
|
activeSpellEffectT["durationLeft"]
|
|
= sol::readonly_property([magicEffectStore](const ESM::ActiveEffect& self) -> sol::optional<float> {
|
|
// Permanent/constant effects, abilities, etc. will have a negative duration
|
|
if (self.mDuration < 0)
|
|
return sol::nullopt;
|
|
auto* rec = magicEffectStore->find(self.mEffectId);
|
|
if (rec->mData.mFlags & ESM::MagicEffect::Flags::NoDuration)
|
|
return sol::nullopt;
|
|
return self.mTimeLeft;
|
|
});
|
|
activeSpellEffectT["duration"]
|
|
= sol::readonly_property([magicEffectStore](const ESM::ActiveEffect& self) -> sol::optional<float> {
|
|
// Permanent/constant effects, abilities, etc. will have a negative duration
|
|
if (self.mDuration < 0)
|
|
return sol::nullopt;
|
|
auto* rec = magicEffectStore->find(self.mEffectId);
|
|
if (rec->mData.mFlags & ESM::MagicEffect::Flags::NoDuration)
|
|
return sol::nullopt;
|
|
return self.mDuration;
|
|
});
|
|
|
|
auto activeSpellT = state.new_usertype<ActiveSpell>("ActiveSpellParams");
|
|
activeSpellT[sol::meta_function::to_string] = [](const ActiveSpell& activeSpell) {
|
|
return "ActiveSpellParams[" + activeSpell.mParams.getSourceSpellId().serializeText() + "]";
|
|
};
|
|
activeSpellT["name"] = sol::readonly_property(
|
|
[](const ActiveSpell& activeSpell) -> std::string_view { return activeSpell.mParams.getDisplayName(); });
|
|
activeSpellT["id"] = sol::readonly_property([](const ActiveSpell& activeSpell) -> std::string {
|
|
return activeSpell.mParams.getSourceSpellId().serializeText();
|
|
});
|
|
activeSpellT["item"]
|
|
= sol::readonly_property([lua = state.lua_state()](const ActiveSpell& activeSpell) -> sol::object {
|
|
auto item = activeSpell.mParams.getItem();
|
|
if (!item.isSet())
|
|
return sol::nil;
|
|
auto itemPtr = MWBase::Environment::get().getWorldModel()->getPtr(item);
|
|
if (itemPtr.isEmpty())
|
|
return sol::nil;
|
|
if (activeSpell.mActor.isGObject())
|
|
return sol::make_object(lua, GObject(itemPtr));
|
|
else
|
|
return sol::make_object(lua, LObject(itemPtr));
|
|
});
|
|
activeSpellT["caster"]
|
|
= sol::readonly_property([lua = state.lua_state()](const ActiveSpell& activeSpell) -> sol::object {
|
|
auto caster = MWBase::Environment::get().getWorldModel()->getPtr(activeSpell.mParams.getCaster());
|
|
if (caster.isEmpty())
|
|
return sol::nil;
|
|
else
|
|
{
|
|
if (activeSpell.mActor.isGObject())
|
|
return sol::make_object(lua, GObject(getId(caster)));
|
|
else
|
|
return sol::make_object(lua, LObject(getId(caster)));
|
|
}
|
|
});
|
|
activeSpellT["effects"]
|
|
= sol::readonly_property([lua = state.lua_state()](const ActiveSpell& activeSpell) -> sol::table {
|
|
sol::table res(lua, sol::create);
|
|
size_t tableIndex = 0;
|
|
for (const ESM::ActiveEffect& e : activeSpell.mParams.getEffects())
|
|
{
|
|
if (!(e.mFlags & ESM::ActiveEffect::Flag_Applied))
|
|
continue;
|
|
res[++tableIndex] = e; // ESM::ActiveEffect (effect params)
|
|
}
|
|
return res;
|
|
});
|
|
activeSpellT["fromEquipment"] = sol::readonly_property([](const ActiveSpell& activeSpell) -> bool {
|
|
return activeSpell.mParams.hasFlag(ESM::ActiveSpells::Flag_Equipment);
|
|
});
|
|
activeSpellT["temporary"] = sol::readonly_property([](const ActiveSpell& activeSpell) -> bool {
|
|
return activeSpell.mParams.hasFlag(ESM::ActiveSpells::Flag_Temporary);
|
|
});
|
|
activeSpellT["affectsBaseValues"] = sol::readonly_property([](const ActiveSpell& activeSpell) -> bool {
|
|
return activeSpell.mParams.hasFlag(ESM::ActiveSpells::Flag_AffectsBaseValues);
|
|
});
|
|
activeSpellT["stackable"] = sol::readonly_property([](const ActiveSpell& activeSpell) -> bool {
|
|
return activeSpell.mParams.hasFlag(ESM::ActiveSpells::Flag_Stackable);
|
|
});
|
|
activeSpellT["activeSpellId"] = sol::readonly_property([](const ActiveSpell& activeSpell) -> std::string {
|
|
return activeSpell.mParams.getActiveSpellId().serializeText();
|
|
});
|
|
|
|
auto activeEffectT = state.new_usertype<ActiveEffect>("ActiveEffect");
|
|
|
|
activeEffectT[sol::meta_function::to_string]
|
|
= [](const ActiveEffect& self) { return std::format("ActiveEffect[{}]", self.key.mId.toDebugString()); };
|
|
activeEffectT["id"]
|
|
= sol::readonly_property([](const ActiveEffect& self) -> ESM::RefId { return self.key.mId; });
|
|
activeEffectT["name"]
|
|
= sol::readonly_property([](const ActiveEffect& self) -> std::string { return self.key.toString(); });
|
|
|
|
activeEffectT["affectedSkill"]
|
|
= sol::readonly_property([magicEffectStore](const ActiveEffect& self) -> sol::optional<std::string> {
|
|
auto* rec = magicEffectStore->find(self.key.mId);
|
|
if (rec->mData.mFlags & ESM::MagicEffect::TargetSkill)
|
|
return self.key.mArg.serializeText();
|
|
return sol::nullopt;
|
|
});
|
|
activeEffectT["affectedAttribute"]
|
|
= sol::readonly_property([magicEffectStore](const ActiveEffect& self) -> sol::optional<std::string> {
|
|
auto* rec = magicEffectStore->find(self.key.mId);
|
|
if (rec->mData.mFlags & ESM::MagicEffect::TargetAttribute)
|
|
return self.key.mArg.serializeText();
|
|
return sol::nullopt;
|
|
});
|
|
|
|
activeEffectT["magnitude"]
|
|
= sol::readonly_property([](const ActiveEffect& self) { return self.param.getMagnitude(); });
|
|
activeEffectT["magnitudeBase"]
|
|
= sol::readonly_property([](const ActiveEffect& self) { return self.param.getBase(); });
|
|
activeEffectT["magnitudeModifier"]
|
|
= sol::readonly_property([](const ActiveEffect& self) { return self.param.getModifier(); });
|
|
|
|
return LuaUtil::makeReadOnly(magicApi);
|
|
}
|
|
|
|
// Override the effect's magnitude range and duration, keeping unspecified values.
|
|
static void applyEffectParams(ESM::ENAMstruct& effect, const sol::table& params)
|
|
{
|
|
effect.mMagnMin = params.get_or<int32_t>("magnitudeMin", effect.mMagnMin);
|
|
effect.mMagnMax = params.get_or<int32_t>("magnitudeMax", effect.mMagnMax);
|
|
effect.mDuration = std::max(params.get_or<int32_t>("duration", effect.mDuration), 0);
|
|
}
|
|
|
|
static std::pair<std::string_view, std::vector<ESM::IndexedENAMstruct>> getNameAndMagicEffects(
|
|
ESM::RefId id, const sol::table& effects)
|
|
{
|
|
const MWWorld::ESMStore& esmStore = *MWBase::Environment::get().getESMStore();
|
|
|
|
auto getEffects = [&](const ESM::EffectList& effectList) {
|
|
std::vector<ESM::IndexedENAMstruct> enams;
|
|
for (const auto& [_, entry] : effects)
|
|
{
|
|
if (!entry.is<sol::table>())
|
|
{
|
|
enams.push_back(effectList.mList.at(LuaUtil::cast<int32_t>(entry)));
|
|
continue;
|
|
}
|
|
sol::table params = entry.as<sol::table>();
|
|
ESM::IndexedENAMstruct& enam
|
|
= enams.emplace_back(effectList.mList.at(LuaUtil::cast<int32_t>(params["index"])));
|
|
applyEffectParams(enam.mData, params);
|
|
}
|
|
return enams;
|
|
};
|
|
|
|
auto getNameAndEffects = [&](auto* record) {
|
|
return std::pair<std::string_view, std::vector<ESM::IndexedENAMstruct>>(
|
|
record->mName, getEffects(record->mEffects));
|
|
};
|
|
auto getNameAndEffectsEnch = [&](auto* record) {
|
|
auto* enchantment = esmStore.get<ESM::Enchantment>().find(record->mEnchant);
|
|
return std::pair<std::string_view, std::vector<ESM::IndexedENAMstruct>>(
|
|
record->mName, getEffects(enchantment->mEffects));
|
|
};
|
|
switch (esmStore.find(id))
|
|
{
|
|
case ESM::REC_ALCH:
|
|
return getNameAndEffects(esmStore.get<ESM::Potion>().find(id));
|
|
case ESM::REC_INGR:
|
|
{
|
|
// Ingredient records do not specify magnitudes or durations.
|
|
const ESM::Ingredient* ingredient = esmStore.get<ESM::Ingredient>().find(id);
|
|
std::vector<ESM::IndexedENAMstruct> enams;
|
|
for (const auto& [_, entry] : effects)
|
|
{
|
|
if (!entry.is<sol::table>())
|
|
throw std::runtime_error("Ingredient effects must be specified as tables");
|
|
sol::table params = entry.as<sol::table>();
|
|
int32_t index = LuaUtil::cast<int32_t>(params["index"]);
|
|
auto effect = MWMechanics::getIngredientEffect(ingredient, index);
|
|
if (!effect)
|
|
throw std::runtime_error("Ingredient has no effect at index " + std::to_string(index));
|
|
applyEffectParams(effect->mData, params);
|
|
enams.push_back(*effect);
|
|
}
|
|
return { ingredient->mName, std::move(enams) };
|
|
}
|
|
case ESM::REC_ARMO:
|
|
return getNameAndEffectsEnch(esmStore.get<ESM::Armor>().find(id));
|
|
case ESM::REC_BOOK:
|
|
return getNameAndEffectsEnch(esmStore.get<ESM::Book>().find(id));
|
|
case ESM::REC_CLOT:
|
|
return getNameAndEffectsEnch(esmStore.get<ESM::Clothing>().find(id));
|
|
case ESM::REC_WEAP:
|
|
return getNameAndEffectsEnch(esmStore.get<ESM::Weapon>().find(id));
|
|
default:
|
|
// esmStore.find doesn't find REC_SPELs
|
|
case ESM::REC_SPEL:
|
|
return getNameAndEffects(esmStore.get<ESM::Spell>().find(id));
|
|
}
|
|
}
|
|
|
|
void addActorMagicBindings(sol::table& actor, const Context& context)
|
|
{
|
|
sol::state_view state = context.sol();
|
|
const MWWorld::Store<ESM::Spell>* spellStore
|
|
= &MWBase::Environment::get().getWorld()->getStore().get<ESM::Spell>();
|
|
|
|
// types.Actor.spells(o)
|
|
actor["spells"] = [](const sol::object& object) { return ActorSpells{ object }; };
|
|
auto spellsT = state.new_usertype<ActorSpells>("ActorSpells");
|
|
spellsT[sol::meta_function::to_string]
|
|
= [](const ActorSpells& spells) { return "ActorSpells[" + spells.mActor.object().toString() + "]"; };
|
|
|
|
actor["activeSpells"] = [](const sol::object& object) { return ActorActiveSpells{ object }; };
|
|
auto activeSpellsT = state.new_usertype<ActorActiveSpells>("ActorActiveSpells");
|
|
activeSpellsT[sol::meta_function::to_string] = [](const ActorActiveSpells& spells) {
|
|
return "ActorActiveSpells[" + spells.mActor.object().toString() + "]";
|
|
};
|
|
|
|
actor["activeEffects"] = [](const sol::object& object) { return ActorActiveEffects{ object }; };
|
|
auto activeEffectsT = state.new_usertype<ActorActiveEffects>("ActorActiveEffects");
|
|
activeEffectsT[sol::meta_function::to_string] = [](const ActorActiveEffects& effects) {
|
|
return "ActorActiveEffects[" + effects.mActor.object().toString() + "]";
|
|
};
|
|
|
|
actor["getSelectedSpell"] = [spellStore](const Object& o) -> sol::optional<const ESM::Spell*> {
|
|
const MWWorld::Ptr& ptr = o.ptr();
|
|
const MWWorld::Class& cls = ptr.getClass();
|
|
if (!cls.isActor())
|
|
throw std::runtime_error("Actor expected");
|
|
ESM::RefId spellId;
|
|
if (ptr == MWBase::Environment::get().getWorld()->getPlayerPtr())
|
|
spellId = MWBase::Environment::get().getWindowManager()->getSelectedSpell();
|
|
else
|
|
spellId = cls.getCreatureStats(ptr).getSpells().getSelectedSpell();
|
|
if (spellId.empty())
|
|
return sol::nullopt;
|
|
else
|
|
return spellStore->find(spellId);
|
|
};
|
|
actor["setSelectedSpell"] = [context, spellStore](const SelfObject& o, const sol::object& spellOrId) {
|
|
const MWWorld::Ptr& ptr = o.ptr();
|
|
const MWWorld::Class& cls = ptr.getClass();
|
|
if (!cls.isActor())
|
|
throw std::runtime_error("Actor expected");
|
|
ESM::RefId spellId;
|
|
if (spellOrId != sol::nil)
|
|
{
|
|
spellId = toSpellId(spellOrId);
|
|
const ESM::Spell* spell = spellStore->find(spellId);
|
|
if (spell->mData.mType != ESM::Spell::ST_Spell && spell->mData.mType != ESM::Spell::ST_Power)
|
|
throw std::runtime_error("Ability or disease can not be casted: " + spellId.toDebugString());
|
|
}
|
|
context.mLuaManager->addAction([obj = Object(ptr), spellId]() {
|
|
const MWWorld::Ptr& objPtr = obj.ptr();
|
|
auto& stats = objPtr.getClass().getCreatureStats(objPtr);
|
|
|
|
// We need to deselect any enchant items before we can select a spell otherwise the item will be
|
|
// reselected
|
|
const auto resetEnchantItem = [&]() {
|
|
MWWorld::ContainerStore& inventory = objPtr.getClass().getContainerStore(objPtr);
|
|
inventory.setSelectedEnchantItem(inventory.end());
|
|
};
|
|
|
|
if (spellId.empty())
|
|
{
|
|
resetEnchantItem();
|
|
if (objPtr == MWBase::Environment::get().getWorld()->getPlayerPtr())
|
|
MWBase::Environment::get().getWindowManager()->unsetSelectedSpell();
|
|
else
|
|
stats.getSpells().setSelectedSpell(ESM::RefId());
|
|
return;
|
|
}
|
|
if (!stats.getSpells().hasSpell(spellId))
|
|
throw std::runtime_error("Actor doesn't know spell " + spellId.toDebugString());
|
|
|
|
resetEnchantItem();
|
|
if (objPtr == MWBase::Environment::get().getWorld()->getPlayerPtr())
|
|
{
|
|
int chance = static_cast<int>(MWMechanics::getSpellSuccessChance(spellId, objPtr));
|
|
MWBase::Environment::get().getWindowManager()->setSelectedSpell(spellId, chance);
|
|
}
|
|
else
|
|
stats.getSpells().setSelectedSpell(spellId);
|
|
});
|
|
};
|
|
|
|
actor["clearSelectedCastable"] = [context](const SelfObject& o) {
|
|
if (!o.ptr().getClass().isActor())
|
|
throw std::runtime_error("Actor expected");
|
|
context.mLuaManager->addAction([obj = Object(o.ptr())]() {
|
|
const MWWorld::Ptr& ptr = obj.ptr();
|
|
auto& stats = ptr.getClass().getCreatureStats(ptr);
|
|
MWWorld::ContainerStore& inventory = ptr.getClass().getContainerStore(ptr);
|
|
inventory.setSelectedEnchantItem(inventory.end());
|
|
if (ptr == MWBase::Environment::get().getWorld()->getPlayerPtr())
|
|
MWBase::Environment::get().getWindowManager()->unsetSelectedSpell();
|
|
else
|
|
stats.getSpells().setSelectedSpell(ESM::RefId());
|
|
});
|
|
};
|
|
|
|
// #(types.Actor.spells(o))
|
|
spellsT[sol::meta_function::length] = [](const ActorSpells& spells) -> size_t {
|
|
if (auto* store = spells.getStore())
|
|
return store->count();
|
|
return 0;
|
|
};
|
|
|
|
// types.Actor.spells(o)[i]
|
|
spellsT[sol::meta_function::index] = sol::overload(
|
|
[](const ActorSpells& spells, size_t index) -> const ESM::Spell* {
|
|
if (auto* store = spells.getStore())
|
|
if (index <= store->count() && index > 0)
|
|
return store->at(LuaUtil::fromLuaIndex(index));
|
|
return nullptr;
|
|
},
|
|
[spellStore](const ActorSpells& spells, std::string_view spellId) -> const ESM::Spell* {
|
|
if (auto* store = spells.getStore())
|
|
{
|
|
const ESM::Spell* spell = spellStore->search(ESM::RefId::deserializeText(spellId));
|
|
if (spell && store->hasSpell(spell))
|
|
return spell;
|
|
}
|
|
return nullptr;
|
|
});
|
|
|
|
// pairs(types.Actor.spells(o))
|
|
spellsT[sol::meta_function::pairs] = state["ipairsForArray"].template get<sol::function>();
|
|
|
|
// ipairs(types.Actor.spells(o))
|
|
spellsT[sol::meta_function::ipairs] = state["ipairsForArray"].template get<sol::function>();
|
|
|
|
// types.Actor.spells(o):add(id)
|
|
spellsT["add"] = [context](const ActorSpells& spells, const sol::object& spellOrId) {
|
|
if (spells.mActor.isLObject())
|
|
throw std::runtime_error("Local scripts can modify only spells of the actor they are attached to.");
|
|
context.mLuaManager->addAction([obj = spells.mActor.object(), spell = toSpell(spellOrId)]() {
|
|
const MWWorld::Ptr& ptr = obj.ptr();
|
|
if (ptr.getClass().isActor())
|
|
ptr.getClass().getCreatureStats(ptr).getSpells().add(spell, false);
|
|
});
|
|
};
|
|
|
|
// types.Actor.spells(o):remove(id)
|
|
spellsT["remove"] = [context](const ActorSpells& spells, const sol::object& spellOrId) {
|
|
if (spells.mActor.isLObject())
|
|
throw std::runtime_error("Local scripts can modify only spells of the actor they are attached to.");
|
|
context.mLuaManager->addAction([obj = spells.mActor.object(), spell = toSpell(spellOrId)]() {
|
|
const MWWorld::Ptr& ptr = obj.ptr();
|
|
if (ptr.getClass().isActor())
|
|
ptr.getClass().getCreatureStats(ptr).getSpells().remove(spell, false);
|
|
});
|
|
};
|
|
|
|
// types.Actor.spells(o):clear()
|
|
spellsT["clear"] = [context](const ActorSpells& spells) {
|
|
if (spells.mActor.isLObject())
|
|
throw std::runtime_error("Local scripts can modify only spells of the actor they are attached to.");
|
|
context.mLuaManager->addAction([obj = spells.mActor.object()]() {
|
|
const MWWorld::Ptr& ptr = obj.ptr();
|
|
if (ptr.getClass().isActor())
|
|
ptr.getClass().getCreatureStats(ptr).getSpells().clear();
|
|
});
|
|
};
|
|
|
|
// types.Actor.spells(o):canUsePower()
|
|
spellsT["canUsePower"] = [](const ActorSpells& spells, const sol::object& spellOrId) -> bool {
|
|
auto* spell = toSpell(spellOrId);
|
|
if (auto* store = spells.getStore())
|
|
return store->canUsePower(spell);
|
|
return false;
|
|
};
|
|
|
|
// pairs(types.Actor.activeSpells(o))
|
|
activeSpellsT["__pairs"] = [](sol::this_state ts, ActorActiveSpells& self) {
|
|
sol::state_view lua(ts);
|
|
self.reset();
|
|
return sol::as_function([lua, self]() mutable -> std::pair<sol::object, sol::object> {
|
|
if (!self.isEnd())
|
|
{
|
|
auto id = sol::make_object(lua, self.mIterator->getSourceSpellId().serializeText());
|
|
auto params = sol::make_object(lua, ActiveSpell{ self.mActor, *self.mIterator });
|
|
self.advance();
|
|
return { id, params };
|
|
}
|
|
else
|
|
{
|
|
return { sol::lua_nil, sol::lua_nil };
|
|
}
|
|
});
|
|
};
|
|
|
|
// types.Actor.activeSpells(o):isSpellActive(id)
|
|
activeSpellsT["isSpellActive"]
|
|
= [](const ActorActiveSpells& activeSpells, const sol::object& recordOrId) -> bool {
|
|
if (auto* store = activeSpells.getStore())
|
|
{
|
|
auto id = toRecordId(recordOrId);
|
|
return store->isSpellActive(id) || store->isEnchantmentActive(id);
|
|
}
|
|
return false;
|
|
};
|
|
|
|
// types.Actor.activeSpells(o):getByActiveSpellId(id)
|
|
activeSpellsT["getByActiveSpellId"]
|
|
= [](const ActorActiveSpells& activeSpells, const std::string_view idStr) -> sol::optional<ActiveSpell> {
|
|
if (auto* store = activeSpells.getStore())
|
|
{
|
|
auto it = store->getActiveSpellById(ESM::RefId::deserializeText(idStr));
|
|
if (it != store->end())
|
|
{
|
|
return ActiveSpell{ activeSpells.mActor, *it };
|
|
}
|
|
}
|
|
return sol::nullopt;
|
|
};
|
|
|
|
// types.Actor.activeSpells(o):remove(id)
|
|
activeSpellsT["remove"] = [context](const ActorActiveSpells& spells, std::string_view idStr) {
|
|
if (spells.isLObject())
|
|
throw std::runtime_error("Local scripts can modify effect only on the actor they are attached to.");
|
|
|
|
context.mLuaManager->addAction([spells = spells, id = ESM::RefId::deserializeText(idStr)]() {
|
|
if (auto* store = spells.getStore())
|
|
{
|
|
auto it = store->getActiveSpellById(id);
|
|
if (it != store->end())
|
|
{
|
|
if (it->hasFlag(ESM::ActiveSpells::Flag_Temporary))
|
|
store->removeEffectsByActiveSpellId(spells.mActor.ptr(), id);
|
|
else
|
|
throw std::runtime_error("Can only remove temporary effects.");
|
|
}
|
|
}
|
|
});
|
|
};
|
|
|
|
// types.Actor.activeSpells(o):add(options)
|
|
activeSpellsT["add"] = [context](const ActorActiveSpells& spells, const sol::table& options) {
|
|
if (spells.isLObject())
|
|
throw std::runtime_error("Local scripts can modify effect only on the actor they are attached to.");
|
|
if (auto* store = spells.getStore())
|
|
{
|
|
ESM::RefId id = ESM::RefId::deserializeText(options.get<std::string_view>("id"));
|
|
sol::optional<Object> item = options.get<sol::optional<Object>>("item");
|
|
ESM::RefNum itemId;
|
|
if (item)
|
|
itemId = item->id();
|
|
sol::optional<Object> caster = options.get<sol::optional<Object>>("caster");
|
|
bool stackable = options.get_or("stackable", false);
|
|
bool ignoreReflect = options.get_or("ignoreReflect", false);
|
|
bool ignoreSpellAbsorption = options.get_or("ignoreSpellAbsorption", false);
|
|
bool ignoreResistances = options.get_or("ignoreResistances", false);
|
|
sol::table effects = options.get<sol::table>("effects");
|
|
if (effects.empty())
|
|
throw std::runtime_error("Error: Parameter 'effects': cannot be an empty list/table");
|
|
const MWWorld::ESMStore& esmStore = *MWBase::Environment::get().getESMStore();
|
|
auto [name, enams] = getNameAndMagicEffects(id, effects);
|
|
name = options.get_or<std::string_view>("name", name);
|
|
|
|
MWWorld::Ptr casterPtr;
|
|
if (caster)
|
|
casterPtr = caster->ptrOrEmpty();
|
|
bool casterIsPlayer = casterPtr == MWMechanics::getPlayer();
|
|
bool targetIsPlayer = spells.mActor.ptr() == MWMechanics::getPlayer();
|
|
|
|
bool affectsHealth = false;
|
|
MWMechanics::ActiveSpells::ActiveSpellParams params(casterPtr, id, name, itemId);
|
|
params.setFlag(ESM::ActiveSpells::Flag_Lua);
|
|
params.setFlag(ESM::ActiveSpells::Flag_Temporary);
|
|
if (stackable)
|
|
params.setFlag(ESM::ActiveSpells::Flag_Stackable);
|
|
params.setActiveSpellId(MWBase::Environment::get().getESMStore()->generateId());
|
|
|
|
for (const ESM::IndexedENAMstruct& enam : enams)
|
|
{
|
|
const ESM::MagicEffect* mgef = esmStore.get<ESM::MagicEffect>().find(enam.mData.mEffectID);
|
|
MWMechanics::ActiveSpells::ActiveEffect effect;
|
|
effect.mEffectId = enam.mData.mEffectID;
|
|
effect.mArg = MWMechanics::EffectKey(enam.mData).mArg;
|
|
effect.mMagnitude = 0.f;
|
|
effect.mMinMagnitude = static_cast<float>(enam.mData.mMagnMin);
|
|
effect.mMaxMagnitude = static_cast<float>(enam.mData.mMagnMax);
|
|
effect.mEffectIndex = static_cast<int32_t>(enam.mIndex);
|
|
effect.mFlags = ESM::ActiveEffect::Flag_None;
|
|
if (ignoreReflect)
|
|
effect.mFlags |= ESM::ActiveEffect::Flag_Ignore_Reflect;
|
|
if (ignoreSpellAbsorption)
|
|
effect.mFlags |= ESM::ActiveEffect::Flag_Ignore_SpellAbsorption;
|
|
if (ignoreResistances)
|
|
effect.mFlags |= ESM::ActiveEffect::Flag_Ignore_Resistances;
|
|
|
|
bool hasDuration = !(mgef->mData.mFlags & ESM::MagicEffect::NoDuration);
|
|
effect.mDuration = hasDuration ? static_cast<float>(enam.mData.mDuration) : 1.f;
|
|
|
|
effect.mTimeLeft = effect.mDuration;
|
|
params.getEffects().emplace_back(effect);
|
|
|
|
affectsHealth = affectsHealth || mgef->mData.mFlags & ESM::MagicEffect::Harmful
|
|
|| effect.mEffectId == ESM::MagicEffect::RestoreHealth;
|
|
}
|
|
store->addSpell(params);
|
|
if (affectsHealth && casterIsPlayer && !targetIsPlayer)
|
|
{
|
|
context.mLuaManager->addAction([enemy = spells.mActor.object()]() {
|
|
// If player is attempting to cast a harmful spell on or is healing a living target, show
|
|
// the target's HP bar.
|
|
MWBase::Environment::get().getWindowManager()->setEnemy(enemy.ptr());
|
|
});
|
|
}
|
|
|
|
// Need to update UI explicitly in case game is currently paused
|
|
if (targetIsPlayer && MWBase::Environment::get().getWorld()->getTimeManager()->isPaused())
|
|
{
|
|
context.mLuaManager->addAction([]() {
|
|
MWBase::Environment::get().getMechanicsManager()->updateMagicEffects(MWMechanics::getPlayer());
|
|
MWBase::Environment::get().getWindowManager()->updateSpellWindow();
|
|
});
|
|
}
|
|
|
|
return params.getActiveSpellId();
|
|
}
|
|
return ESM::RefId();
|
|
};
|
|
|
|
// pairs(types.Actor.activeEffects(o))
|
|
// Note that the indexes are fake, and only for consistency with other lua pairs interfaces. You can't use them
|
|
// for anything.
|
|
activeEffectsT["__pairs"] = [](sol::this_state ts, ActorActiveEffects& self) {
|
|
sol::state_view lua(ts);
|
|
self.reset();
|
|
return sol::as_function([lua, self]() mutable -> std::pair<sol::object, sol::object> {
|
|
while (!self.isEnd())
|
|
{
|
|
if (self.mIterator->second.getBase() == 0 && self.mIterator->second.getModifier() == 0.f)
|
|
{
|
|
self.advance();
|
|
continue;
|
|
}
|
|
ActiveEffect effect = ActiveEffect{ self.mIterator->first, self.mIterator->second };
|
|
auto result = sol::make_object(lua, effect);
|
|
|
|
auto key = sol::make_object(lua, self.mIterator->first.toString());
|
|
self.advance();
|
|
return { key, result };
|
|
}
|
|
return { sol::lua_nil, sol::lua_nil };
|
|
});
|
|
};
|
|
|
|
auto getEffectKey
|
|
= [](std::string_view idStr, sol::optional<std::string_view> argStr) -> MWMechanics::EffectKey {
|
|
auto id = ESM::RefId::deserializeText(idStr);
|
|
auto* rec = MWBase::Environment::get().getWorld()->getStore().get<ESM::MagicEffect>().find(id);
|
|
|
|
MWMechanics::EffectKey key = MWMechanics::EffectKey(id);
|
|
|
|
if (argStr.has_value()
|
|
&& (rec->mData.mFlags & (ESM::MagicEffect::TargetAttribute | ESM::MagicEffect::TargetSkill)))
|
|
{
|
|
// MWLua exposes attributes and skills as strings, so we have to convert them back to IDs here
|
|
if (rec->mData.mFlags & ESM::MagicEffect::TargetAttribute)
|
|
{
|
|
ESM::RefId attribute = ESM::RefId::deserializeText(argStr.value());
|
|
key = MWMechanics::EffectKey(id, attribute);
|
|
}
|
|
|
|
if (rec->mData.mFlags & ESM::MagicEffect::TargetSkill)
|
|
{
|
|
ESM::RefId skill = ESM::RefId::deserializeText(argStr.value());
|
|
key = MWMechanics::EffectKey(id, skill);
|
|
}
|
|
}
|
|
|
|
return key;
|
|
};
|
|
|
|
// types.Actor.activeEffects(o):getEffect(id, ?arg)
|
|
activeEffectsT["getEffect"] = [getEffectKey](const ActorActiveEffects& effects, std::string_view idStr,
|
|
sol::optional<std::string_view> argStr) -> sol::optional<ActiveEffect> {
|
|
if (!effects.isActor())
|
|
return sol::nullopt;
|
|
|
|
MWMechanics::EffectKey key = getEffectKey(idStr, argStr);
|
|
|
|
if (auto* store = effects.getStore())
|
|
if (auto effect = store->get(key))
|
|
return ActiveEffect{ key, effect.value() };
|
|
return ActiveEffect{ key, MWMechanics::EffectParam() };
|
|
};
|
|
|
|
// types.Actor.activeEffects(o):removeEffect(id, ?arg)
|
|
activeEffectsT["remove"] = [getEffectKey, context](const ActorActiveEffects& effects, std::string_view idStr,
|
|
sol::optional<std::string_view> argStr) {
|
|
if (!effects.isActor())
|
|
return;
|
|
|
|
if (effects.isLObject())
|
|
throw std::runtime_error("Local scripts can modify effect only on the actor they are attached to.");
|
|
|
|
MWMechanics::EffectKey key = getEffectKey(idStr, argStr);
|
|
|
|
context.mLuaManager->addAction([key, effects]() {
|
|
// Note that, although this is member method of ActorActiveEffects and we are removing an effect (not a
|
|
// spell), we still need to use the active spells store to purge this effect from active spells.
|
|
const auto& ptr = effects.mActor.ptr();
|
|
|
|
auto& activeSpells = ptr.getClass().getCreatureStats(ptr).getActiveSpells();
|
|
activeSpells.purgeEffect(ptr, key.mId, key.mArg);
|
|
});
|
|
};
|
|
|
|
// types.Actor.activeEffects(o):set(value, id, ?arg)
|
|
activeEffectsT["set"] = [getEffectKey](const ActorActiveEffects& effects, int value, std::string_view idStr,
|
|
sol::optional<std::string_view> argStr) {
|
|
if (!effects.isActor())
|
|
return;
|
|
|
|
if (effects.isLObject())
|
|
throw std::runtime_error("Local scripts can modify effect only on the actor they are attached to.");
|
|
|
|
MWMechanics::EffectKey key = getEffectKey(idStr, argStr);
|
|
int currentValue = static_cast<int>(effects.getStore()->getOrDefault(key).getMagnitude());
|
|
effects.getStore()->modifyBase(key, value - currentValue);
|
|
};
|
|
|
|
// types.Actor.activeEffects(o):modify(value, id, ?arg)
|
|
activeEffectsT["modify"] = [getEffectKey](const ActorActiveEffects& effects, int value, std::string_view idStr,
|
|
sol::optional<std::string_view> argStr) {
|
|
if (!effects.isActor())
|
|
return;
|
|
|
|
if (effects.isLObject())
|
|
throw std::runtime_error("Local scripts can modify effect only on the actor they are attached to.");
|
|
|
|
MWMechanics::EffectKey key = getEffectKey(idStr, argStr);
|
|
effects.getStore()->modifyBase(key, value);
|
|
};
|
|
}
|
|
}
|