[Server] Add script functions that get casters of players' active spells

apps/openmw-mp/Script/Functions/Spells.cpp

@@ -180,10 +180,10 @@ const char* SpellFunctions::GetSpellsActiveDisplayName(unsigned short pid, unsig
 bool SpellFunctions::GetSpellsActiveStackingState(unsigned short pid, unsigned int index) noexcept
 {
     Player* player;
-    GET_PLAYER(pid, player, "");
+    GET_PLAYER(pid, player, false);
 
     if (index >= player->spellsActiveChanges.activeSpells.size())
-        return "invalid";
+        return false;
 
     return player->spellsActiveChanges.activeSpells.at(index).isStackingSpell;
 }
@@ -254,6 +254,66 @@ double SpellFunctions::GetSpellsActiveEffectTimeLeft(unsigned short pid, unsigne
     return player->spellsActiveChanges.activeSpells.at(spellIndex).params.mEffects.at(effectIndex).mTimeLeft;
 }
 
+bool SpellFunctions::DoesSpellsActiveHavePlayerCaster(unsigned short pid, unsigned int index) noexcept
+{
+    Player* player;
+    GET_PLAYER(pid, player, false);
+
+    if (index >= player->spellsActiveChanges.activeSpells.size())
+        return false;
+
+    return player->spellsActiveChanges.activeSpells.at(index).caster.isPlayer;
+}
+
+int SpellFunctions::GetSpellsActiveCasterPid(unsigned short pid, unsigned int index) noexcept
+{
+    Player* player;
+    GET_PLAYER(pid, player, -1);
+
+    if (index >= player->spellsActiveChanges.activeSpells.size())
+        return -1;
+
+    Player* caster = Players::getPlayer(player->spellsActiveChanges.activeSpells.at(index).caster.guid);
+
+    if (caster != nullptr)
+        return caster->getId();
+
+    return -1;
+}
+
+const char* SpellFunctions::GetSpellsActiveCasterRefId(unsigned short pid, unsigned int index) noexcept
+{
+    Player* player;
+    GET_PLAYER(pid, player, "");
+
+    if (index >= player->spellsActiveChanges.activeSpells.size())
+        return "";
+
+    return player->spellsActiveChanges.activeSpells.at(index).caster.refId.c_str();
+}
+
+unsigned int SpellFunctions::GetSpellsActiveCasterRefNum(unsigned short pid, unsigned int index) noexcept
+{
+    Player* player;
+    GET_PLAYER(pid, player, 0);
+
+    if (index >= player->spellsActiveChanges.activeSpells.size())
+        return 0;
+
+    return player->spellsActiveChanges.activeSpells.at(index).caster.refNum;
+}
+
+unsigned int SpellFunctions::GetSpellsActiveCasterMpNum(unsigned short pid, unsigned int index) noexcept
+{
+    Player* player;
+    GET_PLAYER(pid, player, 0);
+
+    if (index >= player->spellsActiveChanges.activeSpells.size())
+        return 0;
+
+    return player->spellsActiveChanges.activeSpells.at(index).caster.mpNum;
+}
+
 const char* SpellFunctions::GetCooldownSpellId(unsigned short pid, unsigned int index) noexcept
 {
     Player* player;

apps/openmw-mp/Script/Functions/Spells.hpp

@@ -31,6 +31,12 @@
     {"GetSpellsActiveEffectDuration",    SpellFunctions::GetSpellsActiveEffectDuration},\
     {"GetSpellsActiveEffectTimeLeft",    SpellFunctions::GetSpellsActiveEffectTimeLeft},\
     \
+    {"DoesSpellsActiveHavePlayerCaster", SpellFunctions::DoesSpellsActiveHavePlayerCaster},\
+    {"GetSpellsActiveCasterPid",         SpellFunctions::GetSpellsActiveCasterPid},\
+    {"GetSpellsActiveCasterRefId",       SpellFunctions::GetSpellsActiveCasterRefId},\
+    {"GetSpellsActiveCasterRefNum",      SpellFunctions::GetSpellsActiveCasterRefNum},\
+    {"GetSpellsActiveCasterMpNum",       SpellFunctions::GetSpellsActiveCasterMpNum},\
+    \
     {"GetCooldownSpellId",               SpellFunctions::GetCooldownSpellId},\
     {"GetCooldownStartDay",              SpellFunctions::GetCooldownStartDay},\
     {"GetCooldownStartHour",             SpellFunctions::GetCooldownStartHour},\
@@ -273,6 +279,52 @@ public:
     */
     static double GetSpellsActiveEffectTimeLeft(unsigned short pid, unsigned int spellIndex, unsigned int effectIndex) noexcept;
 
+    /**
+    * \brief Check whether the spell at a certain index in a player's latest spells active changes has a player
+    *        as its caster.
+    *
+    * \param pid The player ID whose spells active changes should be used.
+    * \param index The index of the spell.
+    * \return Whether a player is the caster of the spell.
+    */
+    static bool DoesSpellsActiveHavePlayerCaster(unsigned short pid, unsigned int index) noexcept;
+
+    /**
+    * \brief Get the player ID of the caster of the spell at a certain index in a player's latest spells active changes.
+    *
+    * \param pid The player ID whose spells active changes should be used.
+    * \param index The index of the spell.
+    * \return The player ID of the caster.
+    */
+    static int GetSpellsActiveCasterPid(unsigned short pid, unsigned int index) noexcept;
+
+    /**
+    * \brief Get the refId of the actor caster of the spell at a certain index in a player's latest spells active changes.
+    *
+    * \param pid The player ID whose spells active changes should be used.
+    * \param index The index of the spell.
+    * \return The refId of the caster.
+    */
+    static const char* GetSpellsActiveCasterRefId(unsigned short pid, unsigned int index) noexcept;
+
+    /**
+    * \brief Get the refNum of the actor caster of the spell at a certain index in a player's latest spells active changes.
+    *
+    * \param pid The player ID whose spells active changes should be used.
+    * \param index The index of the spell.
+    * \return The refNum of the caster.
+    */
+    static unsigned int GetSpellsActiveCasterRefNum(unsigned short pid, unsigned int index) noexcept;
+
+    /**
+    * \brief Get the mpNum of the actor caster of the spell at a certain index in a player's latest spells active changes.
+    *
+    * \param pid The player ID whose spells active changes should be used.
+    * \param index The index of the spell.
+    * \return The mpNum of the caster.
+    */
+    static unsigned int GetSpellsActiveCasterMpNum(unsigned short pid, unsigned int index) noexcept;
+
     /**
     * \brief Get the spell id at a certain index in a player's latest cooldown changes.
     *