Jaysyn/UW2_PRC8
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 3 Wiki Activity

Updated for NWNEE 37-13

Browse Source 
Updated for NWNEE 37-13.  Updated NWNxEE.  Full compile. Updated release archive.
This commit is contained in:
Jaysyn904
2025-01-10 20:29:31 -05:00
parent a8639499df
commit 82994dfc26
447 changed files with 10620 additions and 6020 deletions
Download Patch File Download Diff File Expand all files Collapse all files

392
_module/nss/nwnx_effect.nss
View File

@@ -2,13 +2,27 @@
/// @brief Utility functions to manipulate the builtin effect type.
/// @{
/// @file nwnx_effect.nss
#include "nwnx"
const string NWNX_Effect = "NWNX_Effect"; ///< @private
/// EQUIPPED effects are always associated with a slotted item:
/// Setting this duration type requires the effect creator
/// to be set to the (already equipped) item that should remove
/// this effect when unequipped.
/// Removal behaviour for effects where the creator is NOT a equipped
/// item is undefined.
/// They are not removed by resting, cannot be dispelled, etc.
const int DURATION_TYPE_EQUIPPED = 3;
/// These are feat/racial effects used internally by the game to
/// implement things like movement speed changes and darkvision.
/// They cannot be removed by resting, dispelling, etc.
const int DURATION_TYPE_INNATE = 4;
/// An unpacked effect
struct NWNX_EffectUnpacked
{
string sID; ///< @todo Describe
int nType; ///< @todo Describe
int nSubType; ///< @todo Describe
@@ -50,8 +64,12 @@ struct NWNX_EffectUnpacked
object oParam1; ///< @todo Describe
object oParam2; ///< @todo Describe
object oParam3; ///< @todo Describe
vector vParam0; ///< @todo Describe
vector vParam1; ///< @todo Describe
string sTag; ///< @todo Describe
string sItemProp; ///< @todo Describe
};
/// @brief Convert native effect type to unpacked structure.
@@ -64,159 +82,273 @@ struct NWNX_EffectUnpacked NWNX_Effect_UnpackEffect(effect e);
/// @return The effect.
effect NWNX_Effect_PackEffect(struct NWNX_EffectUnpacked e);
/// @brief Set a script with optional data that runs when an effect expires
/// @param e The effect.
/// @param script The script to run when the effect expires.
/// @param data Any other data you wish to send back to the script.
/// @remark OBJECT_SELF in the script is the object the effect is applied to.
/// @note Only works for TEMPORARY and PERMANENT effects applied to an object.
effect NWNX_Effect_SetEffectExpiredScript(effect e, string script, string data = "");
/// @brief replace an already applied effect on an object
/// Only duration, subtype, tag and spell related fields can be overwritten.
/// @note eNew and eOld need to have the same type.
/// @return Number of internal effects updated.
int NWNX_Effect_ReplaceEffect(object obj, effect eOld, effect eNew);
/// @brief Get the data set with NWNX_Effect_SetEffectExpiredScript()
/// @note Should only be called from a script set with NWNX_Effect_SetEffectExpiredScript().
/// @return The data attached to the effect.
string NWNX_Effect_GetEffectExpiredData();
/// @brief Gets the true effect count
/// @param oObject The object to get the count of.
/// @return the number of effects (item properties and other non-exposed effects included)
int NWNX_Effect_GetTrueEffectCount(object oObject);
/// @brief Get the effect creator.
/// @note Should only be called from a script set with NWNX_Effect_SetEffectExpiredScript().
/// @return The object from which the effect originated.
object NWNX_Effect_GetEffectExpiredCreator();
/// @brief Gets a specific effect on an object. This can grab effects normally hidden from developers, such as item properties.
/// @param oObject The object with the effect
/// @param nIndex The point in the array to retrieve (0 to GetTrueEffectCount())
/// @return A constructed NWNX_EffectUnpacked.
struct NWNX_EffectUnpacked NWNX_Effect_GetTrueEffect(object oObject, int nIndex);
/// @brief Replaces an already applied effect with another.
/// @param oObject The object with the effect to replace
/// @param nIndex The array element to be replaced
/// @param e The unpacked effect to replace it with.
/// @note Cannot replace an effect with a different type or ID.
void NWNX_Effect_ReplaceEffectByIndex(object oObject, int nIndex, struct NWNX_EffectUnpacked e);
/// @brief Removes effect by ID
/// @param oObject The object to remove the effect from
/// @param sID The id of the effect, can be retrieved by unpacking effects.
/// @return FALSE/0 on failure TRUE/1 on success.
int NWNX_Effect_RemoveEffectById(object oObject, string sID);
/// @brief Applys an effect, bypassing any processing done by ApplyEffectToObject
/// @param eEffect The effect to be applied.
/// @param oObject The object to apply it to.
void NWNX_Effect_Apply(effect eEffect, object oObject);
/// @brief Sets an effect creator.
/// @param eEffect The effect to be modified.
/// @param oObject The effect creator.
/// @return The effect with creator field set.
effect NWNX_Effect_SetEffectCreator(effect eEffect, object oObject);
/// @brief Checks if the given effect is valid. Unlike the game builtin, this call considers internal types too.
/// @param eEffect The effect to check
/// @return TRUE if the effect is valid (including internal types).
int NWNX_Effect_GetIsEffectValid(effect eEffect);
/// @brief Returns the number of applied effects on the given object.
/// @param oObject The object to get the applied effect count for.
/// @return The number of applied effects, including internal.
int NWNX_Effect_GetAppliedEffectCount(object oObject);
/// @brief Returns the nNth applied effect on a object.
/// @param oObject The object to get the applied effect copy for.
/// @param nNth The effect index to get.
/// @note Make sure to check with NWNX_Effect_GetIsEffectValid, as this iterator also includes internal effects.
/// @return A copy of the applied game effect, or a invalid effect.
effect NWNX_Effect_GetAppliedEffect(object oObject, int nNth);
/// @}
struct NWNX_EffectUnpacked NWNX_Effect_UnpackEffect(effect e)
struct NWNX_EffectUnpacked __NWNX_Effect_ResolveUnpack(int bLink=TRUE)
{
string sFunc = "UnpackEffect";
NWNX_PushArgumentEffect(NWNX_Effect, sFunc, e);
NWNX_CallFunction(NWNX_Effect, sFunc);
struct NWNX_EffectUnpacked n;
n.sTag = NWNX_GetReturnValueString(NWNX_Effect, sFunc);
n.oParam3 = NWNX_GetReturnValueObject(NWNX_Effect, sFunc);
n.oParam2 = NWNX_GetReturnValueObject(NWNX_Effect, sFunc);
n.oParam1 = NWNX_GetReturnValueObject(NWNX_Effect, sFunc);
n.oParam0 = NWNX_GetReturnValueObject(NWNX_Effect, sFunc);
n.sParam5 = NWNX_GetReturnValueString(NWNX_Effect, sFunc);
n.sParam4 = NWNX_GetReturnValueString(NWNX_Effect, sFunc);
n.sParam3 = NWNX_GetReturnValueString(NWNX_Effect, sFunc);
n.sParam2 = NWNX_GetReturnValueString(NWNX_Effect, sFunc);
n.sParam1 = NWNX_GetReturnValueString(NWNX_Effect, sFunc);
n.sParam0 = NWNX_GetReturnValueString(NWNX_Effect, sFunc);
n.fParam3 = NWNX_GetReturnValueFloat(NWNX_Effect, sFunc);
n.fParam2 = NWNX_GetReturnValueFloat(NWNX_Effect, sFunc);
n.fParam1 = NWNX_GetReturnValueFloat(NWNX_Effect, sFunc);
n.fParam0 = NWNX_GetReturnValueFloat(NWNX_Effect, sFunc);
n.nParam7 = NWNX_GetReturnValueInt(NWNX_Effect, sFunc);
n.nParam6 = NWNX_GetReturnValueInt(NWNX_Effect, sFunc);
n.nParam5 = NWNX_GetReturnValueInt(NWNX_Effect, sFunc);
n.nParam4 = NWNX_GetReturnValueInt(NWNX_Effect, sFunc);
n.nParam3 = NWNX_GetReturnValueInt(NWNX_Effect, sFunc);
n.nParam2 = NWNX_GetReturnValueInt(NWNX_Effect, sFunc);
n.nParam1 = NWNX_GetReturnValueInt(NWNX_Effect, sFunc);
n.nParam0 = NWNX_GetReturnValueInt(NWNX_Effect, sFunc);
n.nNumIntegers = NWNX_GetReturnValueInt(NWNX_Effect, sFunc);
n.sItemProp = NWNXPopString();
n.bLinkRightValid = NWNX_GetReturnValueInt(NWNX_Effect, sFunc);
n.eLinkRight = NWNX_GetReturnValueEffect(NWNX_Effect, sFunc);
n.bLinkLeftValid = NWNX_GetReturnValueInt(NWNX_Effect, sFunc);
n.eLinkLeft = NWNX_GetReturnValueEffect(NWNX_Effect, sFunc);
n.sTag = NWNXPopString();
n.nCasterLevel = NWNX_GetReturnValueInt(NWNX_Effect, sFunc);
n.bShowIcon = NWNX_GetReturnValueInt(NWNX_Effect, sFunc);
n.bExpose = NWNX_GetReturnValueInt(NWNX_Effect, sFunc);
n.nSpellId = NWNX_GetReturnValueInt(NWNX_Effect, sFunc);
n.oCreator = NWNX_GetReturnValueObject(NWNX_Effect, sFunc);
n.vParam1 = NWNXPopVector();
n.vParam0 = NWNXPopVector();
n.oParam3 = NWNXPopObject();
n.oParam2 = NWNXPopObject();
n.oParam1 = NWNXPopObject();
n.oParam0 = NWNXPopObject();
n.sParam5 = NWNXPopString();
n.sParam4 = NWNXPopString();
n.sParam3 = NWNXPopString();
n.sParam2 = NWNXPopString();
n.sParam1 = NWNXPopString();
n.sParam0 = NWNXPopString();
n.fParam3 = NWNXPopFloat();
n.fParam2 = NWNXPopFloat();
n.fParam1 = NWNXPopFloat();
n.fParam0 = NWNXPopFloat();
n.nParam7 = NWNXPopInt();
n.nParam6 = NWNXPopInt();
n.nParam5 = NWNXPopInt();
n.nParam4 = NWNXPopInt();
n.nParam3 = NWNXPopInt();
n.nParam2 = NWNXPopInt();
n.nParam1 = NWNXPopInt();
n.nParam0 = NWNXPopInt();
n.nNumIntegers = NWNXPopInt();
n.nExpiryTimeOfDay = NWNX_GetReturnValueInt(NWNX_Effect, sFunc);
n.nExpiryCalendarDay = NWNX_GetReturnValueInt(NWNX_Effect, sFunc);
n.fDuration = NWNX_GetReturnValueFloat(NWNX_Effect, sFunc);
if(bLink)
{
n.bLinkRightValid = NWNXPopInt();
n.eLinkRight = NWNXPopEffect();
n.bLinkLeftValid = NWNXPopInt();
n.eLinkLeft = NWNXPopEffect();
}
else
{
n.bLinkRightValid = FALSE;
n.bLinkLeftValid = FALSE;
}
n.nSubType = NWNX_GetReturnValueInt(NWNX_Effect, sFunc);
n.nType = NWNX_GetReturnValueInt(NWNX_Effect, sFunc);
n.nCasterLevel = NWNXPopInt();
n.bShowIcon = NWNXPopInt();
n.bExpose = NWNXPopInt();
n.nSpellId = NWNXPopInt();
n.oCreator = NWNXPopObject();
n.nExpiryTimeOfDay = NWNXPopInt();
n.nExpiryCalendarDay = NWNXPopInt();
n.fDuration = NWNXPopFloat();
n.nSubType = NWNXPopInt();
n.nType = NWNXPopInt();
n.sID = NWNXPopString();
return n;
}
void __NWNX_Effect_ResolvePack(struct NWNX_EffectUnpacked e, int bReplace=FALSE)
{
if(!bReplace)
NWNXPushInt(e.nType);
NWNXPushInt(e.nSubType);
NWNXPushFloat(e.fDuration);
NWNXPushInt(e.nExpiryCalendarDay);
NWNXPushInt(e.nExpiryTimeOfDay);
NWNXPushObject(e.oCreator);
NWNXPushInt(e.nSpellId);
NWNXPushInt(e.bExpose);
NWNXPushInt(e.bShowIcon);
NWNXPushInt(e.nCasterLevel);
if(!bReplace)
{
NWNXPushEffect(e.eLinkLeft);
NWNXPushInt(e.bLinkLeftValid);
NWNXPushEffect(e.eLinkRight);
NWNXPushInt(e.bLinkRightValid);
}
NWNXPushInt(e.nNumIntegers);
NWNXPushInt(e.nParam0);
NWNXPushInt(e.nParam1);
NWNXPushInt(e.nParam2);
NWNXPushInt(e.nParam3);
NWNXPushInt(e.nParam4);
NWNXPushInt(e.nParam5);
NWNXPushInt(e.nParam6);
NWNXPushInt(e.nParam7);
NWNXPushFloat(e.fParam0);
NWNXPushFloat(e.fParam1);
NWNXPushFloat(e.fParam2);
NWNXPushFloat(e.fParam3);
NWNXPushString(e.sParam0);
NWNXPushString(e.sParam1);
NWNXPushString(e.sParam2);
NWNXPushString(e.sParam3);
NWNXPushString(e.sParam4);
NWNXPushString(e.sParam5);
NWNXPushObject(e.oParam0);
NWNXPushObject(e.oParam1);
NWNXPushObject(e.oParam2);
NWNXPushObject(e.oParam3);
NWNXPushVector(e.vParam0);
NWNXPushVector(e.vParam1);
NWNXPushString(e.sTag);
NWNXPushString(e.sItemProp);
}
struct NWNX_EffectUnpacked NWNX_Effect_UnpackEffect(effect e)
{
NWNXPushEffect(e);
NWNXCall(NWNX_Effect, "UnpackEffect");
return __NWNX_Effect_ResolveUnpack();
}
effect NWNX_Effect_PackEffect(struct NWNX_EffectUnpacked e)
{
string sFunc = "PackEffect";
NWNX_PushArgumentInt(NWNX_Effect, sFunc, e.nType);
NWNX_PushArgumentInt(NWNX_Effect, sFunc, e.nSubType);
NWNX_PushArgumentFloat(NWNX_Effect, sFunc, e.fDuration);
NWNX_PushArgumentInt(NWNX_Effect, sFunc, e.nExpiryCalendarDay);
NWNX_PushArgumentInt(NWNX_Effect, sFunc, e.nExpiryTimeOfDay);
NWNX_PushArgumentObject(NWNX_Effect, sFunc, e.oCreator);
NWNX_PushArgumentInt(NWNX_Effect, sFunc, e.nSpellId);
NWNX_PushArgumentInt(NWNX_Effect, sFunc, e.bExpose);
NWNX_PushArgumentInt(NWNX_Effect, sFunc, e.bShowIcon);
NWNX_PushArgumentInt(NWNX_Effect, sFunc, e.nCasterLevel);
NWNX_PushArgumentEffect(NWNX_Effect, sFunc, e.eLinkLeft);
NWNX_PushArgumentInt(NWNX_Effect, sFunc, e.bLinkLeftValid);
NWNX_PushArgumentEffect(NWNX_Effect, sFunc, e.eLinkRight);
NWNX_PushArgumentInt(NWNX_Effect, sFunc, e.bLinkRightValid);
NWNX_PushArgumentInt(NWNX_Effect, sFunc, e.nNumIntegers);
NWNX_PushArgumentInt(NWNX_Effect, sFunc, e.nParam0);
NWNX_PushArgumentInt(NWNX_Effect, sFunc, e.nParam1);
NWNX_PushArgumentInt(NWNX_Effect, sFunc, e.nParam2);
NWNX_PushArgumentInt(NWNX_Effect, sFunc, e.nParam3);
NWNX_PushArgumentInt(NWNX_Effect, sFunc, e.nParam4);
NWNX_PushArgumentInt(NWNX_Effect, sFunc, e.nParam5);
NWNX_PushArgumentInt(NWNX_Effect, sFunc, e.nParam6);
NWNX_PushArgumentInt(NWNX_Effect, sFunc, e.nParam7);
NWNX_PushArgumentFloat(NWNX_Effect, sFunc, e.fParam0);
NWNX_PushArgumentFloat(NWNX_Effect, sFunc, e.fParam1);
NWNX_PushArgumentFloat(NWNX_Effect, sFunc, e.fParam2);
NWNX_PushArgumentFloat(NWNX_Effect, sFunc, e.fParam3);
NWNX_PushArgumentString(NWNX_Effect, sFunc, e.sParam0);
NWNX_PushArgumentString(NWNX_Effect, sFunc, e.sParam1);
NWNX_PushArgumentString(NWNX_Effect, sFunc, e.sParam2);
NWNX_PushArgumentString(NWNX_Effect, sFunc, e.sParam3);
NWNX_PushArgumentString(NWNX_Effect, sFunc, e.sParam4);
NWNX_PushArgumentString(NWNX_Effect, sFunc, e.sParam5);
NWNX_PushArgumentObject(NWNX_Effect, sFunc, e.oParam0);
NWNX_PushArgumentObject(NWNX_Effect, sFunc, e.oParam1);
NWNX_PushArgumentObject(NWNX_Effect, sFunc, e.oParam2);
NWNX_PushArgumentObject(NWNX_Effect, sFunc, e.oParam3);
NWNX_PushArgumentString(NWNX_Effect, sFunc, e.sTag);
NWNX_CallFunction(NWNX_Effect, sFunc);
return NWNX_GetReturnValueEffect(NWNX_Effect, sFunc);
__NWNX_Effect_ResolvePack(e);
NWNXCall(NWNX_Effect, "PackEffect");
return NWNXPopEffect();
}
effect NWNX_Effect_SetEffectExpiredScript(effect e, string script, string data = "")
int NWNX_Effect_ReplaceEffect(object obj, effect eOld, effect eNew)
{
string sFunc = "SetEffectExpiredScript";
NWNX_PushArgumentString(NWNX_Effect, sFunc, data);
NWNX_PushArgumentString(NWNX_Effect, sFunc, script);
NWNX_PushArgumentEffect(NWNX_Effect, sFunc, e);
NWNX_CallFunction(NWNX_Effect, sFunc);
return NWNX_GetReturnValueEffect(NWNX_Effect, sFunc);
NWNXPushEffect(eNew);
NWNXPushEffect(eOld);
NWNXPushObject(obj);
NWNXCall(NWNX_Effect, "ReplaceEffect");
return NWNXPopInt();
}
string NWNX_Effect_GetEffectExpiredData()
int NWNX_Effect_GetTrueEffectCount(object oObject)
{
string sFunc = "GetEffectExpiredData";
NWNX_CallFunction(NWNX_Effect, sFunc);
return NWNX_GetReturnValueString(NWNX_Effect, sFunc);
NWNXPushObject(oObject);
NWNXCall(NWNX_Effect, "GetTrueEffectCount");
return NWNXPopInt();
}
object NWNX_Effect_GetEffectExpiredCreator()
struct NWNX_EffectUnpacked NWNX_Effect_GetTrueEffect(object oObject, int nIndex)
{
string sFunc = "GetEffectExpiredCreator";
NWNX_CallFunction(NWNX_Effect, sFunc);
return NWNX_GetReturnValueObject(NWNX_Effect, sFunc);
NWNXPushInt(nIndex);
NWNXPushObject(oObject);
NWNXCall(NWNX_Effect, "GetTrueEffect");
return __NWNX_Effect_ResolveUnpack(FALSE);
}
void NWNX_Effect_ReplaceEffectByIndex(object oObject, int nIndex, struct NWNX_EffectUnpacked e)
{
__NWNX_Effect_ResolvePack(e, TRUE);
NWNXPushInt(nIndex);
NWNXPushObject(oObject);
NWNXCall(NWNX_Effect, "ReplaceEffectByIndex");
}
int NWNX_Effect_RemoveEffectById(object oObject, string sID)
{
NWNXPushString(sID);
NWNXPushObject(oObject);
NWNXCall(NWNX_Effect, "RemoveEffectById");
return NWNXPopInt();
}
void NWNX_Effect_Apply(effect eEffect, object oObject)
{
NWNXPushObject(oObject);
NWNXPushEffect(eEffect);
NWNXCall(NWNX_Effect, "Apply");
}
effect NWNX_Effect_SetEffectCreator(effect eEffect, object oObject)
{
NWNXPushObject(oObject);
NWNXPushEffect(eEffect);
NWNXCall(NWNX_Effect, "SetEffectCreator");
return NWNXPopEffect();
}
int NWNX_Effect_GetIsEffectValid(effect eEffect)
{
NWNXPushEffect(eEffect);
NWNXCall(NWNX_Effect, "GetIsEffectValid");
return NWNXPopInt();
}
int NWNX_Effect_GetAppliedEffectCount(object oObject)
{
NWNXPushObject(oObject);
NWNXCall(NWNX_Effect, "GetAppliedEffectCount");
return NWNXPopInt();
}
effect NWNX_Effect_GetAppliedEffect(object oObject, int nNth)
{
NWNXPushInt(nNth);
NWNXPushObject(oObject);
NWNXCall(NWNX_Effect, "GetAppliedEffect");
return NWNXPopEffect();
}