nwnx_deprecated.nss

Go to the documentation of this file.

// The following functions have been removed from NWNX, please replace them with their basegame implementation!
// To use this file, include it to nwnx.nss and recompile all your scripts.
 
// *** NWNX_Creature
 
const int NWNX_CREATURE_CLERIC_DOMAIN_AIR         = 0;
const int NWNX_CREATURE_CLERIC_DOMAIN_ANIMAL      = 1;
const int NWNX_CREATURE_CLERIC_DOMAIN_DEATH       = 3;
const int NWNX_CREATURE_CLERIC_DOMAIN_DESTRUCTION = 4;
const int NWNX_CREATURE_CLERIC_DOMAIN_EARTH       = 5;
const int NWNX_CREATURE_CLERIC_DOMAIN_EVIL        = 6;
const int NWNX_CREATURE_CLERIC_DOMAIN_FIRE        = 7;
const int NWNX_CREATURE_CLERIC_DOMAIN_GOOD        = 8;
const int NWNX_CREATURE_CLERIC_DOMAIN_HEALING     = 9;
const int NWNX_CREATURE_CLERIC_DOMAIN_KNOWLEDGE   = 10;
const int NWNX_CREATURE_CLERIC_DOMAIN_MAGIC       = 13;
const int NWNX_CREATURE_CLERIC_DOMAIN_PLANT       = 14;
const int NWNX_CREATURE_CLERIC_DOMAIN_PROTECTION  = 15;
const int NWNX_CREATURE_CLERIC_DOMAIN_STRENGTH    = 16;
const int NWNX_CREATURE_CLERIC_DOMAIN_SUN         = 17;
const int NWNX_CREATURE_CLERIC_DOMAIN_TRAVEL      = 18;
const int NWNX_CREATURE_CLERIC_DOMAIN_TRICKERY    = 19;
const int NWNX_CREATURE_CLERIC_DOMAIN_WAR         = 20;
const int NWNX_CREATURE_CLERIC_DOMAIN_WATER       = 21;
 
struct NWNX_Creature_MemorisedSpell
{
    int id; 
    int ready; 
    int meta; 
    int domain; 
};
 
int NWNX_Creature_GetMemorisedSpellCountByLevel(object creature, int class, int level);
 
struct NWNX_Creature_MemorisedSpell NWNX_Creature_GetMemorisedSpell(object creature, int class, int level, int index);
 
void NWNX_Creature_SetMemorisedSpell(object creature, int class, int level, int index, struct NWNX_Creature_MemorisedSpell spell);
 
int NWNX_Creature_GetKnownSpellCount(object creature, int class, int level);
 
int NWNX_Creature_GetKnownSpell(object creature, int class, int level, int index);
 
void NWNX_Creature_ClearMemorisedKnownSpells(object creature, int class, int spellId);
 
void NWNX_Creature_ClearMemorisedSpell(object creature, int class, int level, int index);
 
int NWNX_Creature_GetSoundset(object creature);
 
void NWNX_Creature_SetSoundset(object creature, int soundset);
 
void NWNX_Creature_SetGender(object creature, int gender);
 
void NWNX_Creature_RestoreSpells(object creature, int level = -1);
 
int NWNX_Creature_GetDomain(object creature, int class, int index);
 
int NWNX_Creature_GetSpecialization(object creature, int class);
 
int NWNX_Creature_GetSpellUsesLeft(object oCreature, int nSpellID, int nMultiClass, int nDomainLevel = 0, int nMetaMagic = METAMAGIC_NONE);
 
int NWNX_Creature_GetMemorizedSpellReadyCount(object oCreature, int nSpellID, int nMultiClass, int nMetaMagic = METAMAGIC_NONE);
 
void NWNX_Creature_SetEffectIconFlashing(object oCreature, int nIconId, int bFlashing);
 
int NWNX_Creature_GetMemorisedSpellCountByLevel(object creature, int class, int level)
{
    WriteTimestampedLogEntry("WARNING: Calling deprecated NWNX Function: NWNX_Creature_GetMemorisedSpellCountByLevel");
    return GetMemorizedSpellCountByLevel(creature, class, level);
}
 
struct NWNX_Creature_MemorisedSpell NWNX_Creature_GetMemorisedSpell(object creature, int class, int level, int index)
{
    WriteTimestampedLogEntry("WARNING: Calling deprecated NWNX Function: NWNX_Creature_GetMemorisedSpell");
    struct NWNX_Creature_MemorisedSpell spell;
    spell.domain = GetMemorizedSpellIsDomainSpell(creature, class, level, index);
    spell.meta   = GetMemorizedSpellMetaMagic(creature, class, level, index);
    spell.ready  = GetMemorizedSpellReady(creature, class, level, index);
    spell.id     = GetMemorizedSpellId(creature, class, level, index);
    return spell;
}
 
void NWNX_Creature_SetMemorisedSpell(object creature, int class, int level, int index, struct NWNX_Creature_MemorisedSpell spell)
{
    WriteTimestampedLogEntry("WARNING: Calling deprecated NWNX Function: NWNX_Creature_SetMemorisedSpell");
    SetMemorizedSpell(creature, class, level, index, spell.id, spell.ready, spell.meta, spell.domain);
}
 
int NWNX_Creature_GetKnownSpellCount(object creature, int class, int level)
{
    WriteTimestampedLogEntry("WARNING: Calling deprecated NWNX Function: NWNX_Creature_GetKnownSpellCount");
    return GetKnownSpellCount(creature, class, level);
}
 
int NWNX_Creature_GetKnownSpell(object creature, int class, int level, int index)
{
    WriteTimestampedLogEntry("WARNING: Calling deprecated NWNX Function: NWNX_Creature_GetKnownSpell");
    return GetKnownSpellId(creature, class, level, index);
}
 
void NWNX_Creature_ClearMemorisedKnownSpells(object creature, int class, int spellId)
{
    WriteTimestampedLogEntry("WARNING: Calling deprecated NWNX Function: NWNX_Creature_ClearMemorisedKnownSpells");
    ClearMemorizedSpellBySpellId(creature, class, spellId);
}
 
void NWNX_Creature_ClearMemorisedSpell(object creature, int class, int level, int index)
{
    WriteTimestampedLogEntry("WARNING: Calling deprecated NWNX Function: NWNX_Creature_ClearMemorisedSpell");
    ClearMemorizedSpell(creature, class, level, index);
}
 
int NWNX_Creature_GetSoundset(object creature)
{
    WriteTimestampedLogEntry("WARNING: Calling deprecated NWNX Function: NWNX_Creature_GetSoundset");
    return GetSoundset(creature);
}
 
void NWNX_Creature_SetSoundset(object creature, int soundset)
{
    WriteTimestampedLogEntry("WARNING: Calling deprecated NWNX Function: NWNX_Creature_SetSoundset");
    SetSoundset(creature, soundset);
}
 
void NWNX_Creature_SetGender(object creature, int gender)
{
    WriteTimestampedLogEntry("WARNING: Calling deprecated NWNX Function: NWNX_Creature_SetGender");
    SetGender(creature, gender);
}
 
void NWNX_Creature_RestoreSpells(object creature, int level = -1)
{
    WriteTimestampedLogEntry("WARNING: Calling deprecated NWNX Function: NWNX_Creature_RestoreSpells");
    if (level == -1)
    {
        int i;
        for (i = 0; i < 10; i++)
        {
            ReadySpellLevel(creature, i);
        }
    }
    else
        ReadySpellLevel(creature, level);
 
}
 
int NWNX_Creature_GetDomain(object creature, int class, int index)
{
    WriteTimestampedLogEntry("WARNING: Calling deprecated NWNX Function: NWNX_Creature_GetDomain");
    return GetDomain(creature, index, class);
}
 
int NWNX_Creature_GetSpecialization(object creature, int class)
{
    WriteTimestampedLogEntry("WARNING: Calling deprecated NWNX Function: NWNX_Creature_GetSpecialization");
    return GetSpecialization(creature, class);
}
 
int NWNX_Creature_GetSpellUsesLeft(object oCreature, int nSpellID, int nMultiClass, int nDomainLevel = 0, int nMetaMagic = METAMAGIC_NONE)
{
    WriteTimestampedLogEntry("WARNING: Calling deprecated NWNX Function: NWNX_Creature_GetSpellUsesLeft");
    return GetSpellUsesLeft(oCreature, GetClassByPosition(nMultiClass + 1), nSpellID, nMetaMagic, nDomainLevel);
}
 
int NWNX_Creature_GetMemorizedSpellReadyCount(object oCreature, int nSpellID, int nMultiClass, int nMetaMagic = METAMAGIC_NONE)
{
    WriteTimestampedLogEntry("WARNING: Calling deprecated NWNX Function: NWNX_Creature_GetMemorizedSpellReadyCount");
    return GetSpellUsesLeft(oCreature, GetClassByPosition(nMultiClass + 1), nSpellID, nMetaMagic);
}
 
void NWNX_Creature_SetEffectIconFlashing(object oCreature, int nIconId, int bFlashing)
{
    WriteTimestampedLogEntry("WARNING: Calling deprecated NWNX Function: NWNX_Creature_SetEffectIconFlashing");
    SetEffectIconFlashing(oCreature, nIconId, bFlashing);
}
 
// *** NWNX_Effect
 
effect NWNX_Effect_SetEffectExpiredScript(effect e, string script, string data = "");
 
string NWNX_Effect_GetEffectExpiredData();
 
object NWNX_Effect_GetEffectExpiredCreator();
 
effect NWNX_Effect_AccessorizeVisualEffect(effect eEffect);
 
effect NWNX_Effect_SetEffectExpiredScript(effect e, string script, string data = "")
{
    WriteTimestampedLogEntry("WARNING: Calling deprecated NWNX Function: NWNX_Effect_SetEffectExpiredScript");
    return EffectLinkEffects(EffectRunScript("", script, "", 0.0f, data), e);
}
 
string NWNX_Effect_GetEffectExpiredData()
{
    WriteTimestampedLogEntry("WARNING: Calling deprecated NWNX Function: NWNX_Effect_GetEffectExpiredData");
    return GetEffectString(GetLastRunScriptEffect(), 0);
}
 
object NWNX_Effect_GetEffectExpiredCreator()
{
    WriteTimestampedLogEntry("WARNING: Calling deprecated NWNX Function: NWNX_Effect_GetEffectExpiredCreator");
    return GetEffectCreator(GetLastRunScriptEffect());
}
 
effect NWNX_Effect_AccessorizeVisualEffect(effect eEffect)
{
    WriteTimestampedLogEntry("WARNING: Calling deprecated NWNX Function: NWNX_Effect_AccessorizeVisualEffect");
    if (GetEffectType(eEffect) == EFFECT_TYPE_VISUALEFFECT)
        return UnyieldingEffect(eEffect);
    else
        return eEffect;
}
 
// *** NWNX_Object
 
object NWNX_Object_StringToObject(string id);
 
int NWNX_Object_CheckFit(object obj, int baseitem);
 
void NWNX_Object_AddIconEffect(object obj, int nIcon, float fDuration=0.0);
 
void NWNX_Object_RemoveIconEffect(object obj, int nIcon);
 
void NWNX_Object_SetFacing(object oObject, float fDirection);
 
object NWNX_Object_StringToObject(string id)
{
    WriteTimestampedLogEntry("WARNING: Calling deprecated NWNX Function: NWNX_Object_StringToObject");
    return StringToObject(id);
}
 
int NWNX_Object_CheckFit(object obj, int baseitem)
{
    WriteTimestampedLogEntry("WARNING: Calling deprecated NWNX Function: NWNX_Object_CheckFit");
    return GetBaseItemFitsInInventory(baseitem, obj);
}
 
void NWNX_Object_AddIconEffect(object obj, int nIcon, float fDuration=0.0)
{
    WriteTimestampedLogEntry("WARNING: Calling deprecated NWNX Function: NWNX_Object_AddIconEffect");
    effect eEffect = GetFirstEffect(obj);
    while (GetIsEffectValid(eEffect))
    {
        if (GetEffectTag(eEffect) == "NWNX_Object_IconEffect" && GetEffectInteger(eEffect, 0) == nIcon)
            RemoveEffect(obj, eEffect);
        eEffect = GetNextEffect(obj);
    }
 
    effect eIcon = TagEffect(SupernaturalEffect(EffectIcon(nIcon)), "NWNX_Object_IconEffect");
    ApplyEffectToObject(fDuration == 0.0 ? DURATION_TYPE_PERMANENT : DURATION_TYPE_TEMPORARY, eIcon, obj, fDuration);
}
 
void NWNX_Object_RemoveIconEffect(object obj, int nIcon)
{
    WriteTimestampedLogEntry("WARNING: Calling deprecated NWNX Function: NWNX_Object_RemoveIconEffect");
    effect eEffect = GetFirstEffect(obj);
    while (GetIsEffectValid(eEffect))
    {
        if (GetEffectTag(eEffect) == "NWNX_Object_IconEffect" && GetEffectInteger(eEffect, 0) == nIcon)
            RemoveEffect(obj, eEffect);
        eEffect = GetNextEffect(obj);
    }
}
 
void NWNX_Object_SetFacing(object oObject, float fDirection)
{
    WriteTimestampedLogEntry("WARNING: Calling deprecated NWNX Function: NWNX_Object_SetFacing");
    AssignCommand(oObject, SetFacing(fDirection));
}
 
// *** NWNX_Regex
 
int NWNX_Regex_Search(string str, string regex);
 
string NWNX_Regex_Replace(string str, string regex, string replace = "", int firstOnly = FALSE);
 
json NWNX_Regex_Match(string str, string regex);
 
int NWNX_Regex_Search(string str, string regex)
{
    WriteTimestampedLogEntry("WARNING: Calling deprecated NWNX Function: NWNX_Regex_Search");
    return JsonGetLength(RegExpMatch(regex, str));
}
 
string NWNX_Regex_Replace(string str, string regex, string replace="", int firstOnly=0)
{
    WriteTimestampedLogEntry("WARNING: Calling deprecated NWNX Function: NWNX_Regex_Replace");
    return RegExpReplace(regex, str, replace, firstOnly ? REGEXP_FORMAT_FIRST_ONLY : REGEXP_FORMAT_DEFAULT);
}
 
json NWNX_Regex_Match(string str, string regex)
{
    WriteTimestampedLogEntry("WARNING: Calling deprecated NWNX Function: NWNX_Regex_Match");
    return RegExpIterate(regex, str);
}
 
// *** NWNX_Util
 
int NWNX_Util_IsValidResRef(string resref, int type = RESTYPE_UTC);
 
int NWNX_Util_Get2DARowCount(string str);
 
string NWNX_Util_GetNSSContents(string sScriptName, int nMaxLength = -1);
 
int NWNX_Util_GetServerTicksPerSecond();
 
int NWNX_Util_IsValidResRef(string resref, int type = RESTYPE_UTC)
{
    WriteTimestampedLogEntry("WARNING: Calling deprecated NWNX Function: NWNX_Util_IsValidResRef");
    return ResManGetAliasFor(resref, type) != "";
}
 
int NWNX_Util_Get2DARowCount(string str)
{
    WriteTimestampedLogEntry("WARNING: Calling deprecated NWNX Function: NWNX_Util_Get2DARowCount");
    return Get2DARowCount(str);
}
 
string NWNX_Util_GetNSSContents(string sScriptName, int nMaxLength = -1)
{
    WriteTimestampedLogEntry("WARNING: Calling deprecated NWNX Function: NWNX_Util_GetNSSContents");
    string s = ResManGetFileContents(sScriptName, RESTYPE_NSS);
    return nMaxLength == -1 ? s : GetStringLeft(s, nMaxLength);
}
 
int NWNX_Util_GetServerTicksPerSecond()
{
    WriteTimestampedLogEntry("WARNING: Calling deprecated NWNX Function: NWNX_Util_GetServerTicksPerSecond");
    return GetTickRate();
}