nwnx_util.nss

Go to the documentation of this file.

#include "nwnx"
 
const string NWNX_Util = "NWNX_Util"; 
 
const int NWNX_UTIL_RESREF_TYPE_NSS       = 2009;
const int NWNX_UTIL_RESREF_TYPE_NCS       = 2010;
const int NWNX_UTIL_RESREF_TYPE_AREA_ARE  = 2012;
const int NWNX_UTIL_RESREF_TYPE_TWODA     = 2017;
const int NWNX_UTIL_RESREF_TYPE_AREA_GIT  = 2023;
const int NWNX_UTIL_RESREF_TYPE_ITEM      = 2025;
const int NWNX_UTIL_RESREF_TYPE_CREATURE  = 2027;
const int NWNX_UTIL_RESREF_TYPE_DIALOG    = 2029;
const int NWNX_UTIL_RESREF_TYPE_TRIGGER   = 2032;
const int NWNX_UTIL_RESREF_TYPE_SOUND     = 2035;
const int NWNX_UTIL_RESREF_TYPE_ENCOUNTER = 2040;
const int NWNX_UTIL_RESREF_TYPE_DOOR      = 2042;
const int NWNX_UTIL_RESREF_TYPE_PLACEABLE = 2044;
const int NWNX_UTIL_RESREF_TYPE_STORE     = 2051;
const int NWNX_UTIL_RESREF_TYPE_WAYPOINT  = 2058;
 
struct NWNX_Util_WorldTime
{
    int nCalendarDay; 
    int nTimeOfDay; 
};
 
struct NWNX_Util_HighResTimestamp
{
    int seconds; 
    int microseconds; 
};
 
string NWNX_Util_GetCurrentScriptName(int depth = 0);
 
string NWNX_Util_GetAsciiTableString();
 
int NWNX_Util_Hash(string str);
 
int NWNX_Util_GetModuleMtime();
 
string NWNX_Util_GetModuleFile();
 
string NWNX_Util_GetCustomToken(int customTokenNumber);
 
itemproperty NWNX_Util_EffectToItemProperty(effect e);
 
effect NWNX_Util_ItemPropertyToEffect(itemproperty ip);
 
string NWNX_Util_StripColors(string str);
 
string NWNX_Util_GetEnvironmentVariable(string sVarname);
 
int NWNX_Util_GetMinutesPerHour();
 
void NWNX_Util_SetMinutesPerHour(int minutes);
 
string NWNX_Util_EncodeStringForURL(string str);
 
string NWNX_Util_GetFirstResRef(int nType, string sRegexFilter = "", int bModuleResourcesOnly = TRUE);
 
string NWNX_Util_GetNextResRef();
 
object NWNX_Util_GetLastCreatedObject(int nObjectType, int nNthLast = 1);
 
string NWNX_Util_AddScript(string sFileName, string sScriptData, int bWrapIntoMain = FALSE, string sAlias = "NWNX");
 
int NWNX_Util_AddNSSFile(string sFileName, string sContents, string sAlias = "NWNX");
 
int NWNX_Util_RemoveNWNXResourceFile(string sFileName, int nType, string sAlias = "NWNX");
 
void NWNX_Util_SetInstructionLimit(int nInstructionLimit);
 
int NWNX_Util_GetInstructionLimit();
 
void NWNX_Util_SetInstructionsExecuted(int nInstructions);
 
int NWNX_Util_GetInstructionsExecuted();
 
int NWNX_Util_RegisterServerConsoleCommand(string sCommand, string sScriptChunk);
 
void NWNX_Util_UnregisterServerConsoleCommand(string sCommand);
 
int NWNX_Util_PluginExists(string sPlugin);
 
string NWNX_Util_GetUserDirectory();
 
int NWNX_Util_GetScriptReturnValue();
 
object NWNX_Util_CreateDoor(string sResRef, location locLocation, string sNewTag = "", int nAppearanceType = -1);
 
void NWNX_Util_SetItemActivator(object oObject);
 
struct NWNX_Util_WorldTime NWNX_Util_GetWorldTime(float fAdjustment = 0.0f);
 
void NWNX_Util_SetResourceOverride(int nResType, string sOldName, string sNewName);
 
string NWNX_Util_GetResourceOverride(int nResType, string sName);
 
int NWNX_Util_GetScriptParamIsSet(string sParamName);
 
void NWNX_Util_SetDawnHour(int nDawnHour);
 
void NWNX_Util_SetDuskHour(int nDuskHour);
 
struct NWNX_Util_HighResTimestamp NWNX_Util_GetHighResTimeStamp();
 
string NWNX_Util_GetTTY();
 
void NWNX_Util_SetCurrentlyRunningEvent(int nEventID);
 
int NWNX_Util_GetStringLevenshteinDistance(string sString, string sCompareTo);
 
void NWNX_Util_UpdateClientObject(object oObjectToUpdate, object oPlayer = OBJECT_INVALID);
 
int NWNX_Util_CleanResourceDirectory(string sAlias, int nResType = 0xFFFF);
 
string NWNX_Util_GetModuleTlkFile();
 
 
string NWNX_Util_GetCurrentScriptName(int depth = 0)
{
    string sFunc = "GetCurrentScriptName";
    NWNX_PushArgumentInt(depth);
    NWNX_CallFunction(NWNX_Util, sFunc);
    return NWNX_GetReturnValueString();
}
 
string NWNX_Util_GetAsciiTableString()
{
    string sFunc = "GetAsciiTableString";
    NWNX_CallFunction(NWNX_Util, sFunc);
    return NWNX_GetReturnValueString();
}
 
int NWNX_Util_Hash(string str)
{
    string sFunc = "Hash";
    NWNX_PushArgumentString(str);
    NWNX_CallFunction(NWNX_Util, sFunc);
    return NWNX_GetReturnValueInt();
}
 
int NWNX_Util_GetModuleMtime()
{
    NWNX_CallFunction(NWNX_Util, "GetModuleMtime");
    return NWNX_GetReturnValueInt();
}
 
string NWNX_Util_GetModuleFile()
{
    NWNX_CallFunction(NWNX_Util, "GetModuleFile");
    return NWNX_GetReturnValueString();
}
 
string NWNX_Util_GetCustomToken(int customTokenNumber)
{
    string sFunc = "GetCustomToken";
    NWNX_PushArgumentInt(customTokenNumber);
    NWNX_CallFunction(NWNX_Util, sFunc);
    return NWNX_GetReturnValueString();
}
 
itemproperty NWNX_Util_EffectToItemProperty(effect e)
{
    string sFunc = "EffectTypeCast";
    NWNX_PushArgumentEffect(e);
    NWNX_CallFunction(NWNX_Util, sFunc);
    return NWNX_GetReturnValueItemProperty();
}
 
effect NWNX_Util_ItemPropertyToEffect(itemproperty ip)
{
    string sFunc = "EffectTypeCast";
    NWNX_PushArgumentItemProperty(ip);
    NWNX_CallFunction(NWNX_Util, sFunc);
    return NWNX_GetReturnValueEffect();
}
 
string NWNX_Util_StripColors(string str)
{
    string sFunc = "StripColors";
    NWNX_PushArgumentString(str);
    NWNX_CallFunction(NWNX_Util, sFunc);
    return NWNX_GetReturnValueString();
}
 
string NWNX_Util_GetEnvironmentVariable(string sVarname)
{
    string sFunc = "GetEnvironmentVariable";
    NWNX_PushArgumentString(sVarname);
    NWNX_CallFunction(NWNX_Util, sFunc);
    return NWNX_GetReturnValueString();
}
 
int NWNX_Util_GetMinutesPerHour()
{
    string sFunc = "GetMinutesPerHour";
    NWNX_CallFunction(NWNX_Util, sFunc);
    return NWNX_GetReturnValueInt();
}
 
void NWNX_Util_SetMinutesPerHour(int minutes)
{
    string sFunc = "SetMinutesPerHour";
    NWNX_PushArgumentInt(minutes);
    NWNX_CallFunction(NWNX_Util, sFunc);
}
 
string NWNX_Util_EncodeStringForURL(string sURL)
{
    string sFunc = "EncodeStringForURL";
 
    NWNX_PushArgumentString(sURL);
    NWNX_CallFunction(NWNX_Util, sFunc);
 
    return NWNX_GetReturnValueString();
}
 
string NWNX_Util_GetFirstResRef(int nType, string sRegexFilter = "", int bModuleResourcesOnly = TRUE)
{
    string sFunc = "GetFirstResRef";
 
    NWNX_PushArgumentInt(bModuleResourcesOnly);
    NWNX_PushArgumentString(sRegexFilter);
    NWNX_PushArgumentInt(nType);
    NWNX_CallFunction(NWNX_Util, sFunc);
 
    return NWNX_GetReturnValueString();
}
 
string NWNX_Util_GetNextResRef()
{
    string sFunc = "GetNextResRef";
 
    NWNX_CallFunction(NWNX_Util, sFunc);
 
    return NWNX_GetReturnValueString();
}
 
object NWNX_Util_GetLastCreatedObject(int nObjectType, int nNthLast = 1)
{
    string sFunc = "GetLastCreatedObject";
 
    NWNX_PushArgumentInt(nNthLast);
    NWNX_PushArgumentInt(nObjectType);
    NWNX_CallFunction(NWNX_Util, sFunc);
 
    return NWNX_GetReturnValueObject();
}
 
string NWNX_Util_AddScript(string sFileName, string sScriptData, int bWrapIntoMain = FALSE, string sAlias = "NWNX")
{
    string sFunc = "AddScript";
 
    NWNX_PushArgumentString(sAlias);
    NWNX_PushArgumentInt(bWrapIntoMain);
    NWNX_PushArgumentString(sScriptData);
    NWNX_PushArgumentString(sFileName);
    NWNX_CallFunction(NWNX_Util, sFunc);
 
    return NWNX_GetReturnValueString();
}
 
int NWNX_Util_AddNSSFile(string sFileName, string sContents, string sAlias = "NWNX")
{
    string sFunc = "AddNSSFile";
 
    NWNX_PushArgumentString(sAlias);
    NWNX_PushArgumentString(sContents);
    NWNX_PushArgumentString(sFileName);
    NWNX_CallFunction(NWNX_Util, sFunc);
 
    return NWNX_GetReturnValueInt();
}
 
int NWNX_Util_RemoveNWNXResourceFile(string sFileName, int nType, string sAlias = "NWNX")
{
    string sFunc = "RemoveNWNXResourceFile";
 
    NWNX_PushArgumentString(sAlias);
    NWNX_PushArgumentInt(nType);
    NWNX_PushArgumentString(sFileName);
    NWNX_CallFunction(NWNX_Util, sFunc);
 
    return NWNX_GetReturnValueInt();
}
 
void NWNX_Util_SetInstructionLimit(int nInstructionLimit)
{
    string sFunc = "SetInstructionLimit";
 
    NWNX_PushArgumentInt(nInstructionLimit);
    NWNX_CallFunction(NWNX_Util, sFunc);
}
 
int NWNX_Util_GetInstructionLimit()
{
    string sFunc = "GetInstructionLimit";
 
    NWNX_CallFunction(NWNX_Util, sFunc);
 
    return NWNX_GetReturnValueInt();
}
 
void NWNX_Util_SetInstructionsExecuted(int nInstructions)
{
    string sFunc = "SetInstructionsExecuted";
 
    NWNX_PushArgumentInt(nInstructions);
    NWNX_CallFunction(NWNX_Util, sFunc);
}
 
int NWNX_Util_GetInstructionsExecuted()
{
    string sFunc = "GetInstructionsExecuted";
 
    NWNX_CallFunction(NWNX_Util, sFunc);
 
    return NWNX_GetReturnValueInt();
}
 
int NWNX_Util_RegisterServerConsoleCommand(string sCommand, string sScriptChunk)
{
    string sFunc = "RegisterServerConsoleCommand";
 
    NWNX_PushArgumentString(sScriptChunk);
    NWNX_PushArgumentString(sCommand);
    NWNX_CallFunction(NWNX_Util, sFunc);
 
    return NWNX_GetReturnValueInt();
}
 
void NWNX_Util_UnregisterServerConsoleCommand(string sCommand)
{
    string sFunc = "UnregisterServerConsoleCommand";
 
    NWNX_PushArgumentString(sCommand);
    NWNX_CallFunction(NWNX_Util, sFunc);
}
 
int NWNX_Util_PluginExists(string sPlugin)
{
    WriteTimestampedLogEntry("WARNING:  NWNX_Util_PluginExists is deprecated.  You should migrate to NWNX_PluginExists.");
    return NWNX_PluginExists(sPlugin);
}
 
string NWNX_Util_GetUserDirectory()
{
    string sFunc = "GetUserDirectory";
    NWNX_CallFunction(NWNX_Util, sFunc);
    return NWNX_GetReturnValueString();
}
 
int NWNX_Util_GetScriptReturnValue()
{
    string sFunc = "GetScriptReturnValue";
 
    NWNX_CallFunction(NWNX_Util, sFunc);
 
    return NWNX_GetReturnValueInt();
}
 
object NWNX_Util_CreateDoor(string sResRef, location locLocation, string sNewTag = "", int nAppearanceType = -1)
{
    string sFunc = "CreateDoor";
 
    vector vPosition = GetPositionFromLocation(locLocation);
 
    NWNX_PushArgumentInt(nAppearanceType);
    NWNX_PushArgumentString(sNewTag);
    NWNX_PushArgumentFloat(GetFacingFromLocation(locLocation));
    NWNX_PushArgumentFloat(vPosition.z);
    NWNX_PushArgumentFloat(vPosition.y);
    NWNX_PushArgumentFloat(vPosition.x);
    NWNX_PushArgumentObject(GetAreaFromLocation(locLocation));
    NWNX_PushArgumentString(sResRef);
    NWNX_CallFunction(NWNX_Util, sFunc);
 
    return NWNX_GetReturnValueObject();
}
 
void NWNX_Util_SetItemActivator(object oObject)
{
    string sFunc = "SetItemActivator";
 
    NWNX_PushArgumentObject(oObject);
    NWNX_CallFunction(NWNX_Util, sFunc);
}
 
struct NWNX_Util_WorldTime NWNX_Util_GetWorldTime(float fAdjustment = 0.0f)
{
    string sFunc = "GetWorldTime";
 
    NWNX_PushArgumentFloat(fAdjustment);
    NWNX_CallFunction(NWNX_Util, sFunc);
 
    struct NWNX_Util_WorldTime strWorldTime;
    strWorldTime.nTimeOfDay = NWNX_GetReturnValueInt();
    strWorldTime.nCalendarDay = NWNX_GetReturnValueInt();
 
    return strWorldTime;
}
 
void NWNX_Util_SetResourceOverride(int nResType, string sOldName, string sNewName)
{
    string sFunc = "SetResourceOverride";
 
    NWNX_PushArgumentString(sNewName);
    NWNX_PushArgumentString(sOldName);
    NWNX_PushArgumentInt(nResType);
    NWNX_CallFunction(NWNX_Util, sFunc);
}
 
string NWNX_Util_GetResourceOverride(int nResType, string sName)
{
    string sFunc = "GetResourceOverride";
 
    NWNX_PushArgumentString(sName);
    NWNX_PushArgumentInt(nResType);
    NWNX_CallFunction(NWNX_Util, sFunc);
 
    return NWNX_GetReturnValueString();
}
 
int NWNX_Util_GetScriptParamIsSet(string sParamName)
{
    string sFunc = "GetScriptParamIsSet";
 
    NWNX_PushArgumentString(sParamName);
    NWNX_CallFunction(NWNX_Util, sFunc);
 
    return NWNX_GetReturnValueInt();
}
 
void NWNX_Util_SetDawnHour(int nDawnHour)
{
    string sFunc = "SetDawnHour";
 
    NWNX_PushArgumentInt(nDawnHour);
    NWNX_CallFunction(NWNX_Util, sFunc);
}
 
void NWNX_Util_SetDuskHour(int nDuskHour)
{
    string sFunc = "SetDuskHour";
 
    NWNX_PushArgumentInt(nDuskHour);
    NWNX_CallFunction(NWNX_Util, sFunc);
}
 
struct NWNX_Util_HighResTimestamp NWNX_Util_GetHighResTimeStamp()
{
    struct NWNX_Util_HighResTimestamp t;
    string sFunc = "GetHighResTimeStamp";
 
    NWNX_CallFunction(NWNX_Util, sFunc);
    t.microseconds = NWNX_GetReturnValueInt();
    t.seconds = NWNX_GetReturnValueInt();
    return t;
}
 
string NWNX_Util_GetTTY()
{
    string sFunc = "GetTTY";
 
    NWNX_CallFunction(NWNX_Util, sFunc);
    return NWNX_GetReturnValueString();
}
 
void NWNX_Util_SetCurrentlyRunningEvent(int nEventID)
{
    string sFunc = "SetCurrentlyRunningEvent";
 
    NWNX_PushArgumentInt(nEventID);
    NWNX_CallFunction(NWNX_Util, sFunc);
}
 
int NWNX_Util_GetStringLevenshteinDistance(string sString, string sCompareTo)
{
    string sFunc = "LevenshteinDistance";
 
    NWNX_PushArgumentString(sCompareTo);
    NWNX_PushArgumentString(sString);
    NWNX_CallFunction(NWNX_Util, sFunc);
    return NWNX_GetReturnValueInt();
}
 
void NWNX_Util_UpdateClientObject(object oObjectToUpdate, object oPlayer = OBJECT_INVALID)
{
    string sFunc = "UpdateClientObject";
 
    NWNX_PushArgumentObject(oPlayer);
    NWNX_PushArgumentObject(oObjectToUpdate);
    NWNX_CallFunction(NWNX_Util, sFunc);
}
 
int NWNX_Util_CleanResourceDirectory(string sAlias, int nResType = 0xFFFF)
{
    string sFunc = "CleanResourceDirectory";
    NWNX_PushArgumentInt(nResType);
    NWNX_PushArgumentString(sAlias);
    NWNX_CallFunction(NWNX_Util, sFunc);
    return NWNX_GetReturnValueInt();
}
 
string NWNX_Util_GetModuleTlkFile()
{
    string sFunc = "GetModuleTlkFile";
    NWNX_CallFunction(NWNX_Util, sFunc);
    return NWNX_GetReturnValueString();
}