nwnx_util.nss

Go to the documentation of this file.

 
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);
 
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);
 
int NWNX_Util_GetDawnHour();
 
void NWNX_Util_SetDuskHour(int nDuskHour);
 
int NWNX_Util_GetDuskHour();
 
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();
 
int NWNX_Util_UpdateResourceDirectory(string sAlias);
 
 
string NWNX_Util_GetCurrentScriptName(int depth = 0)
{
    NWNXPushInt(depth);
    NWNXCall(NWNX_Util, "GetCurrentScriptName");
    return NWNXPopString();
}
 
string NWNX_Util_GetAsciiTableString()
{
    NWNXCall(NWNX_Util, "GetAsciiTableString");
    return NWNXPopString();
}
 
int NWNX_Util_Hash(string str)
{
    NWNXPushString(str);
    NWNXCall(NWNX_Util, "Hash");
    return NWNXPopInt();
}
 
int NWNX_Util_GetModuleMtime()
{
    NWNXCall(NWNX_Util, "GetModuleMtime");
    return NWNXPopInt();
}
 
string NWNX_Util_GetModuleFile()
{
    NWNXCall(NWNX_Util, "GetModuleFile");
    return NWNXPopString();
}
 
string NWNX_Util_GetCustomToken(int customTokenNumber)
{
    NWNXPushInt(customTokenNumber);
    NWNXCall(NWNX_Util, "GetCustomToken");
    return NWNXPopString();
}
 
itemproperty NWNX_Util_EffectToItemProperty(effect e)
{
    NWNXPushEffect(e);
    NWNXCall(NWNX_Util, "EffectTypeCast");
    return NWNXPopItemProperty();
}
 
effect NWNX_Util_ItemPropertyToEffect(itemproperty ip)
{
    NWNXPushItemProperty(ip);
    NWNXCall(NWNX_Util, "EffectTypeCast");
    return NWNXPopEffect();
}
 
string NWNX_Util_StripColors(string str)
{
    NWNXPushString(str);
    NWNXCall(NWNX_Util, "StripColors");
    return NWNXPopString();
}
 
string NWNX_Util_GetEnvironmentVariable(string sVarname)
{
    NWNXPushString(sVarname);
    NWNXCall(NWNX_Util, "GetEnvironmentVariable");
    return NWNXPopString();
}
 
int NWNX_Util_GetMinutesPerHour()
{
    NWNXCall(NWNX_Util, "GetMinutesPerHour");
    return NWNXPopInt();
}
 
void NWNX_Util_SetMinutesPerHour(int minutes)
{
    NWNXPushInt(minutes);
    NWNXCall(NWNX_Util, "SetMinutesPerHour");
}
 
string NWNX_Util_EncodeStringForURL(string sURL)
{
    NWNXPushString(sURL);
    NWNXCall(NWNX_Util, "EncodeStringForURL");
    return NWNXPopString();
}
 
string NWNX_Util_GetFirstResRef(int nType, string sRegexFilter = "", int bModuleResourcesOnly = TRUE)
{
    NWNXPushInt(bModuleResourcesOnly);
    NWNXPushString(sRegexFilter);
    NWNXPushInt(nType);
    NWNXCall(NWNX_Util, "GetFirstResRef");
    return NWNXPopString();
}
 
string NWNX_Util_GetNextResRef()
{
    NWNXCall(NWNX_Util, "GetNextResRef");
    return NWNXPopString();
}
 
object NWNX_Util_GetLastCreatedObject(int nObjectType, int nNthLast = 1)
{
    NWNXPushInt(nNthLast);
    NWNXPushInt(nObjectType);
    NWNXCall(NWNX_Util, "GetLastCreatedObject");
    return NWNXPopObject();
}
 
string NWNX_Util_AddScript(string sFileName, string sScriptData, int bWrapIntoMain = FALSE, string sAlias = "NWNX")
{
    NWNXPushString(sAlias);
    NWNXPushInt(bWrapIntoMain);
    NWNXPushString(sScriptData);
    NWNXPushString(sFileName);
    NWNXCall(NWNX_Util, "AddScript");
    return NWNXPopString();
}
 
int NWNX_Util_AddNSSFile(string sFileName, string sContents, string sAlias = "NWNX")
{
    NWNXPushString(sAlias);
    NWNXPushString(sContents);
    NWNXPushString(sFileName);
    NWNXCall(NWNX_Util, "AddNSSFile");
    return NWNXPopInt();
}
 
int NWNX_Util_RemoveNWNXResourceFile(string sFileName, int nType, string sAlias = "NWNX")
{
    NWNXPushString(sAlias);
    NWNXPushInt(nType);
    NWNXPushString(sFileName);
    NWNXCall(NWNX_Util, "RemoveNWNXResourceFile");
    return NWNXPopInt();
}
 
void NWNX_Util_SetInstructionLimit(int nInstructionLimit)
{
    NWNXPushInt(nInstructionLimit);
    NWNXCall(NWNX_Util, "SetInstructionLimit");
}
 
int NWNX_Util_GetInstructionLimit()
{
    NWNXCall(NWNX_Util, "GetInstructionLimit");
    return NWNXPopInt();
}
 
void NWNX_Util_SetInstructionsExecuted(int nInstructions)
{
    NWNXPushInt(nInstructions);
    NWNXCall(NWNX_Util, "SetInstructionsExecuted");
}
 
int NWNX_Util_GetInstructionsExecuted()
{
    NWNXCall(NWNX_Util, "GetInstructionsExecuted");
    return NWNXPopInt();
}
 
int NWNX_Util_RegisterServerConsoleCommand(string sCommand, string sScriptChunk)
{
    NWNXPushString(sScriptChunk);
    NWNXPushString(sCommand);
    NWNXCall(NWNX_Util, "RegisterServerConsoleCommand");
    return NWNXPopInt();
}
 
void NWNX_Util_UnregisterServerConsoleCommand(string sCommand)
{
    NWNXPushString(sCommand);
    NWNXCall(NWNX_Util, "UnregisterServerConsoleCommand");
}
 
string NWNX_Util_GetUserDirectory()
{
    NWNXCall(NWNX_Util, "GetUserDirectory");
    return NWNXPopString();
}
 
int NWNX_Util_GetScriptReturnValue()
{
    NWNXCall(NWNX_Util, "GetScriptReturnValue");
    return NWNXPopInt();
}
 
object NWNX_Util_CreateDoor(string sResRef, location locLocation, string sNewTag = "", int nAppearanceType = -1)
{
    NWNXPushInt(nAppearanceType);
    NWNXPushString(sNewTag);
    NWNXPushLocation(locLocation);
    NWNXPushString(sResRef);
    NWNXCall(NWNX_Util, "CreateDoor");
    return NWNXPopObject();
}
 
void NWNX_Util_SetItemActivator(object oObject)
{
    NWNXPushObject(oObject);
    NWNXCall(NWNX_Util, "SetItemActivator");
}
 
struct NWNX_Util_WorldTime NWNX_Util_GetWorldTime(float fAdjustment = 0.0f)
{
    NWNXPushFloat(fAdjustment);
    NWNXCall(NWNX_Util, "GetWorldTime");
    struct NWNX_Util_WorldTime strWorldTime;
    strWorldTime.nTimeOfDay = NWNXPopInt();
    strWorldTime.nCalendarDay = NWNXPopInt();
    return strWorldTime;
}
 
void NWNX_Util_SetResourceOverride(int nResType, string sOldName, string sNewName)
{
    NWNXPushString(sNewName);
    NWNXPushString(sOldName);
    NWNXPushInt(nResType);
    NWNXCall(NWNX_Util, "SetResourceOverride");
}
 
string NWNX_Util_GetResourceOverride(int nResType, string sName)
{
    NWNXPushString(sName);
    NWNXPushInt(nResType);
    NWNXCall(NWNX_Util, "GetResourceOverride");
    return NWNXPopString();
}
 
int NWNX_Util_GetScriptParamIsSet(string sParamName)
{
    NWNXPushString(sParamName);
    NWNXCall(NWNX_Util, "GetScriptParamIsSet");
    return NWNXPopInt();
}
 
void NWNX_Util_SetDawnHour(int nDawnHour)
{
    NWNXPushInt(nDawnHour);
    NWNXCall(NWNX_Util, "SetDawnHour");
}
 
int NWNX_Util_GetDawnHour()
{
    NWNXCall(NWNX_Util, "GetDawnHour");
    return NWNXPopInt();
}
 
void NWNX_Util_SetDuskHour(int nDuskHour)
{
    NWNXPushInt(nDuskHour);
    NWNXCall(NWNX_Util, "SetDuskHour");
}
 
int NWNX_Util_GetDuskHour()
{
    NWNXCall(NWNX_Util, "GetDuskHour");
    return NWNXPopInt();
}
 
struct NWNX_Util_HighResTimestamp NWNX_Util_GetHighResTimeStamp()
{
    struct NWNX_Util_HighResTimestamp t;
    NWNXCall(NWNX_Util, "GetHighResTimeStamp");
    t.microseconds = NWNXPopInt();
    t.seconds = NWNXPopInt();
    return t;
}
 
string NWNX_Util_GetTTY()
{
    NWNXCall(NWNX_Util, "GetTTY");
    return NWNXPopString();
}
 
void NWNX_Util_SetCurrentlyRunningEvent(int nEventID)
{
    NWNXPushInt(nEventID);
    NWNXCall(NWNX_Util, "SetCurrentlyRunningEvent");
}
 
int NWNX_Util_GetStringLevenshteinDistance(string sString, string sCompareTo)
{
    NWNXPushString(sCompareTo);
    NWNXPushString(sString);
    NWNXCall(NWNX_Util, "GetStringLevenshteinDistance");
    return NWNXPopInt();
}
 
void NWNX_Util_UpdateClientObject(object oObjectToUpdate, object oPlayer = OBJECT_INVALID)
{
    NWNXPushObject(oPlayer);
    NWNXPushObject(oObjectToUpdate);
    NWNXCall(NWNX_Util, "UpdateClientObject");
}
 
int NWNX_Util_CleanResourceDirectory(string sAlias, int nResType = 0xFFFF)
{
    NWNXPushInt(nResType);
    NWNXPushString(sAlias);
    NWNXCall(NWNX_Util, "CleanResourceDirectory");
    return NWNXPopInt();
}
 
string NWNX_Util_GetModuleTlkFile()
{
    string sFunc = "GetModuleTlkFile";
    NWNXCall(NWNX_Util, sFunc);
    return NWNXPopString();
}
 
int NWNX_Util_UpdateResourceDirectory(string sAlias)
{
    NWNXPushString(sAlias);
    NWNXCall(NWNX_Util, "UpdateResourceDirectory");
    return NWNXPopInt();
}