Updated for NWNEE 37-13

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

View File

@@ -0,0 +1,143 @@
//#include "inc_array"
#include "nwnx_time"
// nwnx_data also includes inc_array, so don't double dip.
#include "nwnx_data"
void Log(string msg)
{
WriteTimestampedLogEntry(msg);
}
void TestArrayOnModule()
{
string array = "test";
// By default, temporary arrays are created on the module.
Array_PushBack_Str(array, "BItem1");
Array_PushBack_Str(array, "AItem2");
Array_PushBack_Str(array, "AItem3");
Array_PushBack_Str(array, "BItem2");
Array_Debug_Dump(array, "After first load");
int foo = Array_Find_Str(array, "AItem3");
Log("Found element AItem3 at index = " + IntToString(foo));
Array_Set_Str(array, 2, "Suck it up...");
Array_Debug_Dump(array, "After set 2 = 'Suck it up...'");
Array_Erase(array, 1);
Array_Debug_Dump(array, "After delete 1");
Array_PushBack_Str(array, "MItem1");
Array_PushBack_Str(array, "QItem2");
Array_PushBack_Str(array, "NItem3");
Array_PushBack_Str(array, "KItem2");
Array_Debug_Dump(array, "After add more");
Array_SortAscending(array);
Array_Debug_Dump(array, "After sort");
Array_Shuffle(array);
Array_Debug_Dump(array, "After shuffle");
Log( (Array_Contains_Str(array, "NItem3")) ? "Passed.. found it" : "Failed.. should have found it" );
Log( (Array_Contains_Str(array, "KItem2")) ? "Passed.. found it" : "Failed.. should have found it" );
Log( (Array_Contains_Str(array, "xxxxxx")) ? "Failed.. not found" : "Passed.. should not exist" );
Array_Clear(array);
// Load up the array with 100 entries
int i;
struct NWNX_Time_HighResTimestamp b;
b = NWNX_Time_GetHighResTimeStamp();
Log("Start Time: " + IntToString(b.seconds) + "." + IntToString(b.microseconds));
for (i=0; i<1000; i++)
{
Array_PushBack_Str(array, IntToString(d100()) + " xxx " + IntToString(i));
}
b = NWNX_Time_GetHighResTimeStamp();
Log("Loaded 1000: " + IntToString(b.seconds) + "." + IntToString(b.microseconds));
Array_Shuffle(array);
b = NWNX_Time_GetHighResTimeStamp();
Log("Shuffled 1000: " + IntToString(b.seconds) + "." + IntToString(b.microseconds));
for (i=5; i<995; i++)
{
// Delete the third entry a bunch of times
Array_Erase(array, 3);
}
b = NWNX_Time_GetHighResTimeStamp();
Log("Delete ~990: " + IntToString(b.seconds) + "." + IntToString(b.microseconds));
Array_Debug_Dump(array, "After mass insert/delete");
}
void TestArrayOnChicken()
{
string array="chicken";
// Let's create an array "on" our favorite creature: the deadly nw_chicken
// Note - arrays aren't really attached to the item, but the module, and they
// are tagged with the objects string representation.
object oCreature = CreateObject(OBJECT_TYPE_CREATURE, "nw_chicken", GetStartingLocation());
if (!GetIsObjectValid(oCreature))
{
Log("NWNX_Creature test: Failed to create creature");
return;
}
Array_PushBack_Str(array, "BItem1", oCreature);
Array_PushBack_Str(array, "AItem2", oCreature);
Array_PushBack_Str(array, "AItem3", oCreature);
Array_PushBack_Str(array, "BItem2", oCreature);
Array_Debug_Dump(array, "After Chicken array load", oCreature);
}
void TestNWNXArray()
{
Log("");
Log("Start NWNX_Data test.");
string array = "test2";
NWNX_Data_Array_PushBack_Str(GetModule(), array, "XItem1");
NWNX_Data_Array_PushBack_Str(GetModule(), array, "ZItem2");
NWNX_Data_Array_PushBack_Str(GetModule(), array, "ZItem3");
NWNX_Data_Array_PushBack_Str(GetModule(), array, "XItem2");
Array_Debug_Dump(array, "After first load");
int foo = NWNX_Data_Array_Find_Str(GetModule(), array, "ZItem3");
Log("Found element AItem3 at index = " + IntToString(foo));
NWNX_Data_Array_Set_Str(GetModule(), array, 2, "Suck it up...");
Array_Debug_Dump(array, "After set 2 = 'Suck it up...'");
NWNX_Data_Array_Erase(NWNX_DATA_TYPE_STRING, GetModule(), array, 1);
Array_Debug_Dump(array, "After delete 1");
NWNX_Data_Array_PushBack_Str(GetModule(), array, "MItem1");
NWNX_Data_Array_PushBack_Str(GetModule(), array, "QItem2");
NWNX_Data_Array_PushBack_Str(GetModule(), array, "NItem3");
NWNX_Data_Array_PushBack_Str(GetModule(), array, "KItem2");
Array_Debug_Dump(array, "After add more");
NWNX_Data_Array_SortAscending(NWNX_DATA_TYPE_STRING, GetModule(), array);
Array_Debug_Dump(array, "After sort");
}
// Uncomment and assign to some event click.
/* */
void main()
{
Log("Start");
TestArrayOnModule();
TestArrayOnChicken();
TestNWNXArray();
}
/* */

512
_module/nss/inc_array.nss Normal file
View File

@@ -0,0 +1,512 @@
/// @addtogroup data Data
/// @brief Provides a number of data structures for NWN code to use (simulated arrays)
/// @{
/// @file nwnx_data.nss
const int INVALID_INDEX = -1;
const int TYPE_FLOAT = 0;
const int TYPE_INTEGER = 1;
const int TYPE_OBJECT = 2;
const int TYPE_STRING = 3;
/// @defgroup data_array_at Array At
/// @brief Returns the element at the index.
/// @ingroup data
/// @param obj The object.
/// @param tag The tag.
/// @param index The index.
/// @return The element of associated type.
/// @{
string Array_At_Str(string tag, int index, object obj=OBJECT_INVALID);
float Array_At_Flt(string tag, int index, object obj=OBJECT_INVALID);
int Array_At_Int(string tag, int index, object obj=OBJECT_INVALID);
object Array_At_Obj(string tag, int index, object obj=OBJECT_INVALID);
/// @}
/// Clears the entire array, such that size==0.
void Array_Clear(string tag, object obj=OBJECT_INVALID);
/// @defgroup data_array_contains Array Contains
/// @brief Checks if array contains the element.
/// @ingroup data
/// @param obj The object.
/// @param tag The tag.
/// @param element The element.
/// @return TRUE if the collection contains the element.
/// @{
int Array_Contains_Flt(string tag, float element, object obj=OBJECT_INVALID);
int Array_Contains_Int(string tag, int element, object obj=OBJECT_INVALID);
int Array_Contains_Obj(string tag, object element, object obj=OBJECT_INVALID);
int Array_Contains_Str(string tag, string element, object obj=OBJECT_INVALID);
/// @}
/// Copies the array of name otherTag over the array of name tag.
void Array_Copy(string tag, string otherTag, object obj=OBJECT_INVALID);
/// Erases the element at index, and shuffles any elements from index size-1 to index + 1 left.
void Array_Erase(string tag, int index, object obj=OBJECT_INVALID);
/// @defgroup data_array_find Array Find
/// @brief Get the index at which the element is located.
/// @ingroup data
/// @param obj The object.
/// @param tag The tag.
/// @param element The element.
/// @return Returns the index at which the element is located, or ARRAY_INVALID_INDEX.
/// @{
int Array_Find_Flt(string tag, float element, object obj=OBJECT_INVALID);
int Array_Find_Int(string tag, int element, object obj=OBJECT_INVALID);
int Array_Find_Obj(string tag, object element, object obj=OBJECT_INVALID);
int Array_Find_Str(string tag, string element, object obj=OBJECT_INVALID);
/// @}
/// @defgroup data_array_insert Array Insert
/// @brief Inserts the element at the index, where size > index >= 0.
/// @ingroup data
/// @param obj The object.
/// @param tag The tag.
/// @param index The index.
/// @param element The element.
/// @{
void Array_Insert_Flt(string tag, int index, float element, object obj=OBJECT_INVALID);
void Array_Insert_Int(string tag, int index, int element, object obj=OBJECT_INVALID);
void Array_Insert_Obj(string tag, int index, object element, object obj=OBJECT_INVALID);
void Array_Insert_Str(string tag, int index, string element, object obj=OBJECT_INVALID);
/// @}
/// @defgroup data_array_pushback Array Pushback
/// @brief Pushes an element to the back of the collection.
/// @remark Functionally identical to an insert at index size-1.
/// @ingroup data
/// @param obj The object.
/// @param tag The tag.
/// @param element The element.
/// @{
void Array_PushBack_Flt(string tag, float element, object obj=OBJECT_INVALID);
void Array_PushBack_Int(string tag, int element, object obj=OBJECT_INVALID);
void Array_PushBack_Obj(string tag, object element, object obj=OBJECT_INVALID);
void Array_PushBack_Str(string tag, string element, object obj=OBJECT_INVALID);
/// @}
/// Resizes the array. If the array is shrinking, it chops off elements at the ned.
void Array_Resize(string tag, int size, object obj=OBJECT_INVALID);
/// Reorders the array such each possible permutation of elements has equal probability of appearance.
void Array_Shuffle(string tag, object obj=OBJECT_INVALID);
/// Returns the size of the array.
int Array_Size(string tag, object obj=OBJECT_INVALID);
/// Sorts the collection based on descending order.
void Array_SortAscending(string tag, int type=TYPE_STRING, object obj=OBJECT_INVALID);
/// Sorts the collection based on descending order.
void Array_SortDescending(string tag, int type=TYPE_STRING, object obj=OBJECT_INVALID);
/// @defgroup data_array_set Array Set
/// @brief Sets the element at the index, where size > index >= 0.
/// @ingroup data
/// @param obj The object.
/// @param tag The tag.
/// @param index The index.
/// @param element The element.
/// @{
void Array_Set_Flt(string tag, int index, float element, object obj=OBJECT_INVALID);
void Array_Set_Int(string tag, int index, int element, object obj=OBJECT_INVALID);
void Array_Set_Obj(string tag, int index, object element, object obj=OBJECT_INVALID);
void Array_Set_Str(string tag, int index, string element, object obj=OBJECT_INVALID);
/// @}
/// @}
//
// Local Utility Functions.
//
string GetTableName(string tag, object obj=OBJECT_INVALID, int bare=FALSE) {
if (obj == OBJECT_INVALID)
obj = GetModule();
string sName = "array_" + ObjectToString(obj) + "_" + tag;
// Remove invalid characters from the tag rather than failing.
string sCleansed = RegExpReplace("[^A-Za-z0-9_\$@#]", sName, "");
// But provide some feedback.
if (GetStringLength(sName) != GetStringLength(sCleansed) || GetStringLength(sCleansed) == 0) {
WriteTimestampedLogEntry("WARNING: Invalid table name detected for array with tag <" + tag + ">. Only characters (a-zA-Z0-9), _, @, $ and # are allowed. Using <"+sCleansed+"> instead.");
}
// BARE returns just the table name with no wrapping.
if (bare == TRUE) {
return sCleansed;
}
// Table name wraped in quotes to avoid token expansion.
return "\""+sCleansed+"\"";
}
string GetTableCreateString(string tag, object obj=OBJECT_INVALID) {
// for simplicity sake, everything is turned into a string. Possible enhancement
// to create specific tables for int/float/whatever.
return "CREATE TABLE IF NOT EXISTS " + GetTableName(tag, obj) + " ( ind INTEGER, value TEXT )";
}
int TableExists(string tag, object obj=OBJECT_INVALID) {
string stmt = "SELECT name FROM sqlite_master WHERE type = 'table' AND name = @tablename;";
sqlquery sqlQuery = SqlPrepareQueryObject(GetModule(), stmt);
SqlBindString(sqlQuery, "@tablename", GetTableName(tag, obj, TRUE));
return SqlStep(sqlQuery);
}
void ExecuteStatement(string statement, object obj=OBJECT_INVALID) {
if (obj == OBJECT_INVALID)
obj = GetModule();
// There's no direct "execute this.." everything has to be prepared then executed.
//WriteTimestampedLogEntry("SQL: " + statement);
sqlquery sqlQuery = SqlPrepareQueryObject(GetModule(), statement);
SqlStep(sqlQuery);
}
void CreateArrayTable(string tag, object obj=OBJECT_INVALID) {
string createStatement = GetTableCreateString(tag, obj);
ExecuteStatement(createStatement, obj);
}
// Get the table row count. Returns -1 on error (0 is a valid number of rows in a table)
int GetRowCount(string tag, object obj=OBJECT_INVALID) {
if (obj == OBJECT_INVALID)
obj = GetModule();
CreateArrayTable(tag, obj);
string stmt = "SELECT COUNT(1) FROM " + GetTableName(tag, obj);
sqlquery sqlQuery = SqlPrepareQueryObject(GetModule(), stmt);
if ( SqlStep(sqlQuery) ) {
return SqlGetInt(sqlQuery, 0);
}
return -1;
}
////////////////////////////////////////////////////////////////////////////////
// return the value contained in location "index"
string Array_At_Str(string tag, int index, object obj=OBJECT_INVALID)
{
// Just "create if not exists" to ensure it exists for the insert.
CreateArrayTable(tag, obj);
string stmt = "SELECT value FROM " + GetTableName(tag, obj) + " WHERE ind = @ind";
sqlquery sqlQuery = SqlPrepareQueryObject(GetModule(), stmt);
SqlBindInt(sqlQuery, "@ind", index);
if ( SqlStep(sqlQuery) ) {
return SqlGetString(sqlQuery, 0);
}
return "";
}
float Array_At_Flt(string tag, int index, object obj=OBJECT_INVALID)
{
string st = Array_At_Str(tag, index, obj);
if (st == "") {
return 0.0;
}
return StringToFloat(st);
}
int Array_At_Int(string tag, int index, object obj=OBJECT_INVALID)
{
string st = Array_At_Str(tag, index, obj);
if (st == "") {
return 0;
}
return StringToInt(st);
}
object Array_At_Obj(string tag, int index, object obj=OBJECT_INVALID)
{
string st = Array_At_Str(tag, index, obj);
if (st == "") {
return OBJECT_INVALID;
}
return StringToObject(st);
}
void Array_Clear(string tag, object obj=OBJECT_INVALID)
{
ExecuteStatement("delete from "+GetTableName(tag, obj), obj);
}
////////////////////////////////////////////////////////////////////////////////
// Return true/value (1/0) if the array contains the value "element"
int Array_Contains_Str(string tag, string element, object obj=OBJECT_INVALID)
{
CreateArrayTable(tag, obj);
string stmt = "SELECT COUNT(1) FROM "+GetTableName(tag, obj)+" WHERE value = @element";
sqlquery sqlQuery = SqlPrepareQueryObject(GetModule(), stmt);
SqlBindString(sqlQuery, "@element", element);
int pos = -1;
if ( SqlStep(sqlQuery) ) {
pos = SqlGetInt(sqlQuery, 0);
if (pos > 0) {
return TRUE;
}
}
return FALSE;
}
int Array_Contains_Flt(string tag, float element, object obj=OBJECT_INVALID)
{
return Array_Contains_Str(tag, FloatToString(element), obj);
}
int Array_Contains_Int(string tag, int element, object obj=OBJECT_INVALID)
{
return Array_Contains_Str(tag, IntToString(element), obj);
}
int Array_Contains_Obj(string tag, object element, object obj=OBJECT_INVALID)
{
return Array_Contains_Str(tag, ObjectToString(element), obj);
}
////////////////////////////////////////////////////////////////////////////////
void Array_Copy(string tag, string otherTag, object obj=OBJECT_INVALID)
{
CreateArrayTable(otherTag, obj);
ExecuteStatement("INSERT INTO "+GetTableName(otherTag, obj)+" SELECT * FROM "+GetTableName(tag, obj), obj);
}
////////////////////////////////////////////////////////////////////////////////
void Array_Erase(string tag, int index, object obj=OBJECT_INVALID)
{
int rows = GetRowCount(tag, obj);
// Silently fail if "index" is outside the range of valid indicies.
if (index >= 0 && index < rows) {
string stmt = "DELETE FROM "+GetTableName(tag, obj)+" WHERE ind = @ind";
sqlquery sqlQuery = SqlPrepareQueryObject(GetModule(), stmt);
SqlBindInt(sqlQuery, "@ind", index);
SqlStep(sqlQuery);
stmt = "UPDATE "+GetTableName(tag, obj)+" SET ind = ind - 1 WHERE ind > @ind";
sqlQuery = SqlPrepareQueryObject(GetModule(), stmt);
SqlBindInt(sqlQuery, "@ind", index);
SqlStep(sqlQuery);
}
}
////////////////////////////////////////////////////////////////////////////////
// return the index in the array containing "element"
// if not found, return INVALID_INDEX
int Array_Find_Str(string tag, string element, object obj=OBJECT_INVALID)
{
string stmt;
sqlquery sqlQuery;
// Just create it before trying to select in case it doesn't exist yet.
CreateArrayTable(tag, obj);
stmt = "SELECT IFNULL(MIN(ind),@invalid_index) FROM "+GetTableName(tag, obj)+" WHERE value = @element";
sqlQuery = SqlPrepareQueryObject(GetModule(), stmt);
SqlBindInt(sqlQuery, "@invalid_index", INVALID_INDEX);
SqlBindString(sqlQuery, "@element", element);
if ( SqlStep(sqlQuery) ) {
return SqlGetInt(sqlQuery, 0);
}
return INVALID_INDEX;
}
int Array_Find_Flt(string tag, float element, object obj=OBJECT_INVALID)
{
return Array_Find_Str(tag, FloatToString(element), obj);
}
int Array_Find_Int(string tag, int element, object obj=OBJECT_INVALID)
{
return Array_Find_Str(tag, IntToString(element), obj);
}
int Array_Find_Obj(string tag, object element, object obj=OBJECT_INVALID)
{
return Array_Find_Str(tag, ObjectToString(element), obj);
}
////////////////////////////////////////////////////////////////////////////////
// Insert a new element into position 'index'. If index is beyond the number of rows in the array,
// this will quietly fail. This could be changed if you wanted to support sparse
// arrays.
void Array_Insert_Str(string tag, int index, string element, object obj=OBJECT_INVALID)
{
int rows = GetRowCount(tag, obj);
// Index numbers are off by one, much like C arrays, so for "rows=10" - values are 0-9.
// It's not unreasonable to fail if you try to insert ind=10 into an array who's indexes
// only go to 9, but I guess it doesn't hurt as long as we're not allowing gaps in
// index numbers.
if (index >= 0 && index <= rows) {
// index is passed as an integer, so immune (as far as I know) to SQL injection for a one shot query.
ExecuteStatement("UPDATE "+GetTableName(tag, obj)+" SET ind = ind + 1 WHERE ind >= "+IntToString(index), obj);
// Element, however, is not.
string stmt = "INSERT INTO "+GetTableName(tag, obj)+" VALUES ( @ind, @element )";
sqlquery sqlQuery = SqlPrepareQueryObject(GetModule(), stmt);
SqlBindInt(sqlQuery, "@ind", index);
SqlBindString(sqlQuery, "@element", element);
SqlStep(sqlQuery);
}
}
void Array_Insert_Flt(string tag, int index, float element, object obj=OBJECT_INVALID)
{
Array_Insert_Str(tag, index, FloatToString(element), obj);
}
void Array_Insert_Int(string tag, int index, int element, object obj=OBJECT_INVALID)
{
Array_Insert_Str(tag, index, IntToString(element), obj);
}
void Array_Insert_Obj(string tag, int index, object element, object obj=OBJECT_INVALID)
{
Array_Insert_Str(tag, index, ObjectToString(element), obj);
}
////////////////////////////////////////////////////////////////////////////////
// Insert a new element at the end of the array.
void Array_PushBack_Str(string tag, string element, object obj=OBJECT_INVALID)
{
// Create it before trhing to INSERT into it. If it already exists, this is a no-op.
CreateArrayTable(tag, obj);
// If rowCount = 10, indexes are from 0 to 9, so this becomes the 11th entry at index 10.
int rowCount = GetRowCount(tag, obj);
string stmt = "INSERT INTO "+GetTableName(tag, obj)+" VALUES ( @ind, @element )";
sqlquery sqlQuery = SqlPrepareQueryObject(GetModule(), stmt);
SqlBindInt(sqlQuery, "@ind", rowCount);
SqlBindString(sqlQuery, "@element", element);
SqlStep(sqlQuery);
}
void Array_PushBack_Flt(string tag, float element, object obj=OBJECT_INVALID)
{
Array_PushBack_Str(tag, FloatToString(element), obj);
}
void Array_PushBack_Int(string tag, int element, object obj=OBJECT_INVALID)
{
Array_PushBack_Str(tag, IntToString(element), obj);
}
void Array_PushBack_Obj(string tag, object element, object obj=OBJECT_INVALID)
{
Array_PushBack_Str(tag, ObjectToString(element), obj);
}
////////////////////////////////////////////////////////////////////////////////
// Cuts the array off at size 'size'. Elements beyond size are removed.
void Array_Resize(string tag, int size, object obj=OBJECT_INVALID)
{
// Int immune to sql injection so easier to one-shot it.
ExecuteStatement("DELETE FROM "+GetTableName(tag, obj)+" WHERE ind >= " + IntToString(size), obj);
}
////////////////////////////////////////////////////////////////////////////////
void Array_Shuffle(string tag, object obj=OBJECT_INVALID)
{
string table = GetTableName(tag, obj, TRUE);
ExecuteStatement("CREATE TABLE " +table+ "_temp AS SELECT ROW_NUMBER() OVER(ORDER BY RANDOM())-1, value FROM " +table, obj);
ExecuteStatement("DELETE FROM " +table , obj);
ExecuteStatement("INSERT INTO " +table+ " SELECT * FROM " +table+ "_temp", obj);
ExecuteStatement("DROP TABLE " +table+ "_TEMP", obj);
}
////////////////////////////////////////////////////////////////////////////////
int Array_Size(string tag, object obj=OBJECT_INVALID)
{
return GetRowCount(tag, obj);
}
////////////////////////////////////////////////////////////////////////////////
// Sort the array by value according to 'direction' (ASC or DESC).
// Supplying a type allows for correct numerical sorting of integers or floats.
void Array_Sort(string tag, string dir="ASC", int type=TYPE_STRING, object obj=OBJECT_INVALID)
{
string table = GetTableName(tag, obj, TRUE);
string direction = GetStringUpperCase(dir);
if ( ! (direction == "ASC" || direction == "DESC") ) {
WriteTimestampedLogEntry("WARNING: Invalid sort direction <" + direction + "> supplied. Defaulting to ASC.");
direction = "ASC";
}
// default orderBy for strings.
string orderBy = "ORDER BY value " + direction;
switch(type) {
case TYPE_INTEGER:
orderBy = "ORDER BY CAST(value AS INTEGER)" + direction;
break;
case TYPE_FLOAT:
orderBy = "ORDER BY CAST(value AS DECIMAL)" + direction;
break;
}
ExecuteStatement("CREATE TABLE " +table+ "_temp AS SELECT ROW_NUMBER() OVER(" + orderBy + ")-1, value FROM " +table, obj);
ExecuteStatement("DELETE FROM " +table, obj);
ExecuteStatement("INSERT INTO " +table+ " SELECT * FROM " +table+ "_temp", obj);
ExecuteStatement("DROP TABLE " +table+ "_temp", obj);
}
void Array_SortAscending(string tag, int type=TYPE_STRING, object obj=OBJECT_INVALID)
{
Array_Sort(tag, "ASC", type, obj);
}
void Array_SortDescending(string tag, int type=TYPE_STRING, object obj=OBJECT_INVALID)
{
Array_Sort(tag, "DESC", type, obj);
}
////////////////////////////////////////////////////////////////////////////////
// Set the value of array index 'index' to a 'element'
// This will quietly eat values if index > array size
void Array_Set_Str(string tag, int index, string element, object obj=OBJECT_INVALID)
{
int rows = GetRowCount(tag, obj);
if (index >= 0 && index <= rows) {
string stmt = "UPDATE "+GetTableName(tag, obj)+" SET value = @element WHERE ind = @ind";
sqlquery sqlQuery = SqlPrepareQueryObject(GetModule(), stmt);
SqlBindInt(sqlQuery, "@ind", index);
SqlBindString(sqlQuery, "@element", element);
SqlStep(sqlQuery);
}
}
void Array_Set_Flt(string tag, int index, float element, object obj=OBJECT_INVALID)
{
Array_Set_Str(tag, index, FloatToString(element), obj);
}
void Array_Set_Int(string tag, int index, int element, object obj=OBJECT_INVALID)
{
Array_Set_Str(tag, index, IntToString(element), obj);
}
void Array_Set_Obj(string tag, int index, object element, object obj=OBJECT_INVALID)
{
Array_Set_Str(tag, index, ObjectToString(element), obj);
}
void Array_Debug_Dump(string tag, string title = "xxx", object obj=OBJECT_INVALID) {
if (title != "xxx") {
WriteTimestampedLogEntry("== " + title + " ======================================");
}
WriteTimestampedLogEntry("Table name = " + GetTableName(tag, obj));
string stmt = "SELECT ind, value FROM " + GetTableName(tag, obj);
sqlquery sqlQuery = SqlPrepareQueryObject(GetModule(), stmt);
int ind = -1;
string value = "";
while ( SqlStep(sqlQuery) ) {
ind = SqlGetInt(sqlQuery, 0);
value = SqlGetString(sqlQuery, 1);
WriteTimestampedLogEntry(tag + "[" + IntToString(ind) + "] = " + value);
}
}

View File

@@ -0,0 +1,68 @@
/// @addtogroup time Time
/// @brief Provides various time related functions.
/// @{
/// @file inc_sqlite_time.nss
/// @brief Returns the current time formatted according to the provided sqlite date time format string.
/// @param format Format string as used by sqlites STRFTIME().
/// @return The current time in the requested format. Empty string on error.
string SQLite_GetFormattedSystemTime(string format);
/// @return Returns the number of seconds since midnight on January 1, 1970.
int SQLite_GetTimeStamp();
/// @brief A millisecond timestamp
struct SQLite_MillisecondTimeStamp
{
int seconds; ///< Seconds since epoch
int milliseconds; ///< Milliseconds
};
/// @remark For mircosecond timestamps use NWNX_Utility_GetHighResTimeStamp().
/// @return Returns the number of milliseconds since midnight on January 1, 1970.
struct SQLite_MillisecondTimeStamp SQLite_GetMillisecondTimeStamp();
/// @brief Returns the current date.
/// @return The date in the format (mm/dd/yyyy).
string SQLite_GetSystemDate();
/// @brief Returns current time.
/// @return The current time in the format (24:mm:ss).
string SQLite_GetSystemTime();
/// @}
string SQLite_GetFormattedSystemTime(string format)
{
sqlquery query = SqlPrepareQueryObject(GetModule(), "SELECT STRFTIME(@format, 'now', 'localtime')");
SqlBindString(query, "@format", format);
SqlStep(query); // sqlite returns NULL for invalid format in STRFTIME()
return SqlGetString(query, 0);
}
int SQLite_GetTimeStamp()
{
sqlquery query = SqlPrepareQueryObject(GetModule(), "SELECT STRFTIME('%s', 'now')");
SqlStep(query);
return SqlGetInt(query, 0);
}
struct SQLite_MillisecondTimeStamp SQLite_GetMillisecondTimeStamp()
{
sqlquery query = SqlPrepareQueryObject(GetModule(), "SELECT STRFTIME('%s', 'now'), SUBSTR(STRFTIME('%f', 'now'), 4)");
SqlStep(query);
struct SQLite_MillisecondTimeStamp t;
t.seconds = SqlGetInt(query, 0);
t.milliseconds = SqlGetInt(query, 1);
return t;
}
string SQLite_GetSystemDate()
{
return SQLite_GetFormattedSystemTime("%m/%d/%Y");
}
string SQLite_GetSystemTime()
{
return SQLite_GetFormattedSystemTime("%H:%M:%S");
}

View File

@@ -3,111 +3,135 @@
/// @{
/// @file nwnx.nss
const string NWNX_Core = "NWNX_Core"; ///< @private
/// @brief Scripting interface to NWNX.
/// @param pluginName The plugin name.
/// @param functionName The function name (do not include NWNX_Plugin_).
void NWNX_CallFunction(string pluginName, string functionName);
/// @brief Pushes the specified type to the c++ side
/// @param pluginName The plugin name.
/// @param functionName The function name (do not include NWNX_Plugin_).
/// @param value The value of specified type to push.
void NWNX_PushArgumentInt(string pluginName, string functionName, int value);
void NWNX_PushArgumentInt(int value);
/// @copydoc NWNX_PushArgumentInt()
void NWNX_PushArgumentFloat(string pluginName, string functionName, float value);
void NWNX_PushArgumentFloat(float value);
/// @copydoc NWNX_PushArgumentInt()
void NWNX_PushArgumentObject(string pluginName, string functionName, object value);
void NWNX_PushArgumentObject(object value);
/// @copydoc NWNX_PushArgumentInt()
void NWNX_PushArgumentString(string pluginName, string functionName, string value);
void NWNX_PushArgumentString(string value);
/// @copydoc NWNX_PushArgumentInt()
void NWNX_PushArgumentEffect(string pluginName, string functionName, effect value);
void NWNX_PushArgumentEffect(effect value);
/// @copydoc NWNX_PushArgumentInt()
void NWNX_PushArgumentItemProperty(string pluginName, string functionName, itemproperty value);
void NWNX_PushArgumentItemProperty(itemproperty value);
/// @copydoc NWNX_PushArgumentInt()
void NWNX_PushArgumentJson(json value);
/// @brief Returns the specified type from the c++ side
/// @param pluginName The plugin name.
/// @param functionName The function name (do not include NWNX_Plugin_).
/// @return The value of specified type.
int NWNX_GetReturnValueInt(string pluginName, string functionName);
int NWNX_GetReturnValueInt();
/// @copydoc NWNX_GetReturnValueInt()
float NWNX_GetReturnValueFloat(string pluginName, string functionName);
float NWNX_GetReturnValueFloat();
/// @copydoc NWNX_GetReturnValueInt()
object NWNX_GetReturnValueObject(string pluginName, string functionName);
object NWNX_GetReturnValueObject();
/// @copydoc NWNX_GetReturnValueInt()
string NWNX_GetReturnValueString(string pluginName, string functionName);
string NWNX_GetReturnValueString();
/// @copydoc NWNX_GetReturnValueInt()
effect NWNX_GetReturnValueEffect(string pluginName, string functionName);
effect NWNX_GetReturnValueEffect();
/// @copydoc NWNX_GetReturnValueInt()
itemproperty NWNX_GetReturnValueItemProperty(string pluginName, string functionName);
itemproperty NWNX_GetReturnValueItemProperty();
/// @copydoc NWNX_GetReturnValueInt()
json NWNX_GetReturnValueJson();
/// @brief Determines if the given plugin exists and is enabled.
/// @param sPlugin The name of the plugin to check. This is the case sensitive plugin name as used by NWNX_CallFunction, NWNX_PushArgumentX
/// @note Example usage: NWNX_PluginExists("NWNX_Creature");
/// @return TRUE if the plugin exists and is enabled, otherwise FALSE.
int NWNX_PluginExists(string sPlugin);
/// @private
string NWNX_INTERNAL_BuildString(string pluginName, string functionName, string operation)
{
return "NWNXEE!ABIv2!" + pluginName + "!" + functionName + "!" + operation;
}
const string NWNX_PUSH = "NWNXEE!ABIv2!X!Y!PUSH";
const string NWNX_POP = "NWNXEE!ABIv2!X!Y!POP";
/// @}
void NWNX_CallFunction(string pluginName, string functionName)
{
PlaySound(NWNX_INTERNAL_BuildString(pluginName, functionName, "CALL"));
PlaySound("NWNXEE!ABIv2!" + pluginName + "!" + functionName + "!CALL");
}
void NWNX_PushArgumentInt(string pluginName, string functionName, int value)
void NWNX_PushArgumentInt(int value)
{
SetLocalInt(OBJECT_INVALID, NWNX_INTERNAL_BuildString(pluginName, functionName, "PUSH"), value);
SetLocalInt(OBJECT_INVALID, NWNX_PUSH, value);
}
void NWNX_PushArgumentFloat(string pluginName, string functionName, float value)
void NWNX_PushArgumentFloat(float value)
{
SetLocalFloat(OBJECT_INVALID, NWNX_INTERNAL_BuildString(pluginName, functionName, "PUSH"), value);
SetLocalFloat(OBJECT_INVALID, NWNX_PUSH, value);
}
void NWNX_PushArgumentObject(string pluginName, string functionName, object value)
void NWNX_PushArgumentObject(object value)
{
SetLocalObject(OBJECT_INVALID, NWNX_INTERNAL_BuildString(pluginName, functionName, "PUSH"), value);
SetLocalObject(OBJECT_INVALID, NWNX_PUSH, value);
}
void NWNX_PushArgumentString(string pluginName, string functionName, string value)
void NWNX_PushArgumentString(string value)
{
SetLocalString(OBJECT_INVALID, NWNX_INTERNAL_BuildString(pluginName, functionName, "PUSH"), value);
SetLocalString(OBJECT_INVALID, NWNX_PUSH, value);
}
void NWNX_PushArgumentEffect(string pluginName, string functionName, effect value)
void NWNX_PushArgumentEffect(effect value)
{
TagEffect(value, NWNX_INTERNAL_BuildString(pluginName, functionName, "PUSH"));
TagEffect(value, NWNX_PUSH);
}
void NWNX_PushArgumentItemProperty(string pluginName, string functionName, itemproperty value)
void NWNX_PushArgumentItemProperty(itemproperty value)
{
TagItemProperty(value, NWNX_INTERNAL_BuildString(pluginName, functionName, "PUSH"));
TagItemProperty(value, NWNX_PUSH);
}
int NWNX_GetReturnValueInt(string pluginName, string functionName)
void NWNX_PushArgumentJson(json value)
{
return GetLocalInt(OBJECT_INVALID, NWNX_INTERNAL_BuildString(pluginName, functionName, "POP"));
SetLocalJson(OBJECT_INVALID, NWNX_PUSH, value);
}
float NWNX_GetReturnValueFloat(string pluginName, string functionName)
int NWNX_GetReturnValueInt()
{
return GetLocalFloat(OBJECT_INVALID, NWNX_INTERNAL_BuildString(pluginName, functionName, "POP"));
return GetLocalInt(OBJECT_INVALID, NWNX_POP);
}
object NWNX_GetReturnValueObject(string pluginName, string functionName)
float NWNX_GetReturnValueFloat()
{
return GetLocalObject(OBJECT_INVALID, NWNX_INTERNAL_BuildString(pluginName, functionName, "POP"));
return GetLocalFloat(OBJECT_INVALID, NWNX_POP);
}
string NWNX_GetReturnValueString(string pluginName, string functionName)
object NWNX_GetReturnValueObject()
{
return GetLocalString(OBJECT_INVALID, NWNX_INTERNAL_BuildString(pluginName, functionName, "POP"));
return GetLocalObject(OBJECT_INVALID, NWNX_POP);
}
effect NWNX_GetReturnValueEffect(string pluginName, string functionName)
string NWNX_GetReturnValueString()
{
return GetLocalString(OBJECT_INVALID, NWNX_POP);
}
effect NWNX_GetReturnValueEffect()
{
effect e;
return TagEffect(e, NWNX_INTERNAL_BuildString(pluginName, functionName, "POP"));
return TagEffect(e, NWNX_POP);
}
itemproperty NWNX_GetReturnValueItemProperty(string pluginName, string functionName)
itemproperty NWNX_GetReturnValueItemProperty()
{
itemproperty ip;
return TagItemProperty(ip, NWNX_INTERNAL_BuildString(pluginName, functionName, "POP"));
return TagItemProperty(ip, NWNX_POP);
}
json NWNX_GetReturnValueJson()
{
return GetLocalJson(OBJECT_INVALID, NWNX_POP);
}
int NWNX_PluginExists(string sPlugin)
{
string sFunc = "PluginExists";
NWNX_PushArgumentString(sPlugin);
NWNX_CallFunction(NWNX_Core, sFunc);
return NWNX_GetReturnValueInt();
}

View File

@@ -2,7 +2,6 @@
/// @brief Various admin related functions
/// @{
/// @file nwnx_admin.nss
#include "nwnx"
const string NWNX_Administration = "NWNX_Administration"; ///< @private
@@ -10,16 +9,16 @@ const string NWNX_Administration = "NWNX_Administration"; ///< @private
/// @anchor admin_opts
///
/// @{
const int NWNX_ADMINISTRATION_OPTION_ALL_KILLABLE = 0; // TRUE/FALSE
const int NWNX_ADMINISTRATION_OPTION_NON_PARTY_KILLABLE = 1; // TRUE/FALSE
const int NWNX_ADMINISTRATION_OPTION_REQUIRE_RESURRECTION = 2; // TRUE/FALSE
const int NWNX_ADMINISTRATION_OPTION_LOSE_STOLEN_ITEMS = 3; // TRUE/FALSE
const int NWNX_ADMINISTRATION_OPTION_LOSE_ITEMS = 4; // TRUE/FALSE
const int NWNX_ADMINISTRATION_OPTION_LOSE_EXP = 5; // TRUE/FALSE
const int NWNX_ADMINISTRATION_OPTION_LOSE_GOLD = 6; // TRUE/FALSE
const int NWNX_ADMINISTRATION_OPTION_LOSE_GOLD_NUM = 7;
const int NWNX_ADMINISTRATION_OPTION_LOSE_EXP_NUM = 8;
const int NWNX_ADMINISTRATION_OPTION_LOSE_ITEMS_NUM = 9;
const int NWNX_ADMINISTRATION_OPTION_ALL_KILLABLE = 0; // DOES NOT DO ANYTHING
const int NWNX_ADMINISTRATION_OPTION_NON_PARTY_KILLABLE = 1; // DOES NOT DO ANYTHING
const int NWNX_ADMINISTRATION_OPTION_REQUIRE_RESURRECTION = 2; // DOES NOT DO ANYTHING
const int NWNX_ADMINISTRATION_OPTION_LOSE_STOLEN_ITEMS = 3; // DOES NOT DO ANYTHING
const int NWNX_ADMINISTRATION_OPTION_LOSE_ITEMS = 4; // DOES NOT DO ANYTHING
const int NWNX_ADMINISTRATION_OPTION_LOSE_EXP = 5; // DOES NOT DO ANYTHING
const int NWNX_ADMINISTRATION_OPTION_LOSE_GOLD = 6; // DOES NOT DO ANYTHING
const int NWNX_ADMINISTRATION_OPTION_LOSE_GOLD_NUM = 7; // DOES NOT DO ANYTHING
const int NWNX_ADMINISTRATION_OPTION_LOSE_EXP_NUM = 8; // DOES NOT DO ANYTHING
const int NWNX_ADMINISTRATION_OPTION_LOSE_ITEMS_NUM = 9; // DOES NOT DO ANYTHING
const int NWNX_ADMINISTRATION_OPTION_PVP_SETTING = 10; // 0 = No PVP, 1 = Party PVP, 2 = Full PVP
const int NWNX_ADMINISTRATION_OPTION_PAUSE_AND_PLAY = 11; // TRUE/FALSE
const int NWNX_ADMINISTRATION_OPTION_ONE_PARTY_ONLY = 12; // TRUE/FALSE
@@ -37,6 +36,8 @@ const int NWNX_ADMINISTRATION_OPTION_USE_MAX_HITPOINTS = 23; // TRUE/FA
const int NWNX_ADMINISTRATION_OPTION_RESTORE_SPELLS_USES = 24; // TRUE/FALSE
const int NWNX_ADMINISTRATION_OPTION_RESET_ENCOUNTER_SPAWN_POOL = 25; // TRUE/FALSE
const int NWNX_ADMINISTRATION_OPTION_HIDE_HITPOINTS_GAINED = 26; // TRUE/FALSE
const int NWNX_ADMINISTRATION_OPTION_PLAYER_PARTY_CONTROL = 27; // TRUE/FALSE
const int NWNX_ADMINISTRATION_OPTION_SHOW_PLAYER_JOIN_MESSAGES = 28; // TRUE/FALSE
/// @}
/// @name Administration Debug Types
@@ -77,7 +78,8 @@ void NWNX_Administration_ShutdownServer();
///
/// @param oPC The player to delete.
/// @param bPreserveBackup If true, it will leave the file on server, only appending ".deleted0" to the bic filename.
void NWNX_Administration_DeletePlayerCharacter(object oPC, int bPreserveBackup = TRUE);
/// @param sKickMessage An optional kick message, if left blank it will default to "Delete Character" as reason.
void NWNX_Administration_DeletePlayerCharacter(object oPC, int bPreserveBackup = TRUE, string sKickMessage = "");
/// @brief Bans the provided IP.
/// @param ip The IP Address to ban.
@@ -155,188 +157,182 @@ void NWNX_Administration_SetDebugValue(int type, int state);
/// @warning DANGER, DRAGONS. Bad things may or may not happen.
void NWNX_Administration_ReloadRules();
/// @brief Get the servers minimum level.
/// @return The minimum level for the server.
int NWNX_Administration_GetMinLevel();
/// @brief Set the servers minimum level.
/// @param nLevel The minimum level for the server.
void NWNX_Administration_SetMinLevel(int nLevel);
/// @brief Get the servers maximum level.
/// @return The maximum level for the server.
int NWNX_Administration_GetMaxLevel();
/// @brief Set the servers maximum level.
/// @note Attention when using this and the MaxLevel plugin. They both change the same value.
/// @param nLevel The maximum level for the server.
void NWNX_Administration_SetMaxLevel(int nLevel);
/// @}
string NWNX_Administration_GetPlayerPassword()
{
string sFunc = "GetPlayerPassword";
NWNX_CallFunction(NWNX_Administration, sFunc);
return NWNX_GetReturnValueString(NWNX_Administration, sFunc);
NWNXCall(NWNX_Administration, "GetPlayerPassword");
return NWNXPopString();
}
void NWNX_Administration_SetPlayerPassword(string password)
{
string sFunc = "SetPlayerPassword";
NWNX_PushArgumentString(NWNX_Administration, sFunc, password);
NWNX_CallFunction(NWNX_Administration, sFunc);
NWNXPushString(password);
NWNXCall(NWNX_Administration, "SetPlayerPassword");
}
void NWNX_Administration_ClearPlayerPassword()
{
string sFunc = "ClearPlayerPassword";
NWNX_CallFunction(NWNX_Administration, sFunc);
NWNXCall(NWNX_Administration, "ClearPlayerPassword");
}
string NWNX_Administration_GetDMPassword()
{
string sFunc = "GetDMPassword";
NWNX_CallFunction(NWNX_Administration, sFunc);
return NWNX_GetReturnValueString(NWNX_Administration, sFunc);
NWNXCall(NWNX_Administration, "GetDMPassword");
return NWNXPopString();
}
void NWNX_Administration_SetDMPassword(string password)
{
string sFunc = "SetDMPassword";
NWNX_PushArgumentString(NWNX_Administration, sFunc, password);
NWNX_CallFunction(NWNX_Administration, sFunc);
NWNXPushString(password);
NWNXCall(NWNX_Administration, "SetDMPassword");
}
void NWNX_Administration_ShutdownServer()
{
string sFunc = "ShutdownServer";
NWNX_CallFunction(NWNX_Administration, sFunc);
NWNXCall(NWNX_Administration, "ShutdownServer");
}
void NWNX_Administration_DeletePlayerCharacter(object oPC, int bPreserveBackup)
void NWNX_Administration_DeletePlayerCharacter(object oPC, int bPreserveBackup = TRUE, string sKickMessage = "")
{
string sFunc = "DeletePlayerCharacter";
NWNX_PushArgumentInt(NWNX_Administration, sFunc, bPreserveBackup);
NWNX_PushArgumentObject(NWNX_Administration, sFunc, oPC);
NWNX_CallFunction(NWNX_Administration, sFunc);
NWNXPushString(sKickMessage);
NWNXPushInt(bPreserveBackup);
NWNXPushObject(oPC);
NWNXCall(NWNX_Administration, "DeletePlayerCharacter");
}
void NWNX_Administration_AddBannedIP(string ip)
{
string sFunc = "AddBannedIP";
NWNX_PushArgumentString(NWNX_Administration, sFunc, ip);
NWNX_CallFunction(NWNX_Administration, sFunc);
NWNXPushString(ip);
NWNXCall(NWNX_Administration, "AddBannedIP");
}
void NWNX_Administration_RemoveBannedIP(string ip)
{
string sFunc = "RemoveBannedIP";
NWNX_PushArgumentString(NWNX_Administration, sFunc, ip);
NWNX_CallFunction(NWNX_Administration, sFunc);
NWNXPushString(ip);
NWNXCall(NWNX_Administration, "RemoveBannedIP");
}
void NWNX_Administration_AddBannedCDKey(string key)
{
string sFunc = "AddBannedCDKey";
NWNX_PushArgumentString(NWNX_Administration, sFunc, key);
NWNX_CallFunction(NWNX_Administration, sFunc);
NWNXPushString(key);
NWNXCall(NWNX_Administration, "AddBannedCDKey");
}
void NWNX_Administration_RemoveBannedCDKey(string key)
{
string sFunc = "RemoveBannedCDKey";
NWNX_PushArgumentString(NWNX_Administration, sFunc, key);
NWNX_CallFunction(NWNX_Administration, sFunc);
NWNXPushString(key);
NWNXCall(NWNX_Administration, "RemoveBannedCDKey");
}
void NWNX_Administration_AddBannedPlayerName(string playerName)
{
string sFunc = "AddBannedPlayerName";
NWNX_PushArgumentString(NWNX_Administration, sFunc, playerName);
NWNX_CallFunction(NWNX_Administration, sFunc);
NWNXPushString(playerName);
NWNXCall(NWNX_Administration, "AddBannedPlayerName");
}
void NWNX_Administration_RemoveBannedPlayerName(string playerName)
{
string sFunc = "RemoveBannedPlayerName";
NWNX_PushArgumentString(NWNX_Administration, sFunc, playerName);
NWNX_CallFunction(NWNX_Administration, sFunc);
NWNXPushString(playerName);
NWNXCall(NWNX_Administration, "RemoveBannedPlayerName");
}
string NWNX_Administration_GetBannedList()
{
string sFunc = "GetBannedList";
NWNX_CallFunction(NWNX_Administration, sFunc);
return NWNX_GetReturnValueString(NWNX_Administration, sFunc);
NWNXCall(NWNX_Administration, "GetBannedList");
return NWNXPopString();
}
void NWNX_Administration_SetModuleName(string name)
{
string sFunc = "SetModuleName";
NWNX_PushArgumentString(NWNX_Administration, sFunc, name);
NWNX_CallFunction(NWNX_Administration, sFunc);
NWNXPushString(name);
NWNXCall(NWNX_Administration, "SetModuleName");
}
void NWNX_Administration_SetServerName(string name)
{
string sFunc = "SetServerName";
NWNX_PushArgumentString(NWNX_Administration, sFunc, name);
NWNX_CallFunction(NWNX_Administration, sFunc);
NWNXPushString(name);
NWNXCall(NWNX_Administration, "SetServerName");
}
string NWNX_Administration_GetServerName()
{
string sFunc = "GetServerName";
NWNX_CallFunction(NWNX_Administration, sFunc);
return NWNX_GetReturnValueString(NWNX_Administration, sFunc);
NWNXCall(NWNX_Administration, "GetServerName");
return NWNXPopString();
}
int NWNX_Administration_GetPlayOption(int option)
{
string sFunc = "GetPlayOption";
NWNX_PushArgumentInt(NWNX_Administration, sFunc, option);
NWNX_CallFunction(NWNX_Administration, sFunc);
return NWNX_GetReturnValueInt(NWNX_Administration, sFunc);
NWNXPushInt(option);
NWNXCall(NWNX_Administration, "GetPlayOption");
return NWNXPopInt();
}
void NWNX_Administration_SetPlayOption(int option, int value)
{
string sFunc = "SetPlayOption";
NWNX_PushArgumentInt(NWNX_Administration, sFunc, value);
NWNX_PushArgumentInt(NWNX_Administration, sFunc, option);
NWNX_CallFunction(NWNX_Administration, sFunc);
NWNXPushInt(value);
NWNXPushInt(option);
NWNXCall(NWNX_Administration, "SetPlayOption");
}
int NWNX_Administration_DeleteTURD(string playerName, string characterName)
{
string sFunc = "DeleteTURD";
NWNX_PushArgumentString(NWNX_Administration, sFunc, characterName);
NWNX_PushArgumentString(NWNX_Administration, sFunc, playerName);
NWNX_CallFunction(NWNX_Administration, sFunc);
return NWNX_GetReturnValueInt(NWNX_Administration, sFunc);
NWNXPushString(characterName);
NWNXPushString(playerName);
NWNXCall(NWNX_Administration, "DeleteTURD");
return NWNXPopInt();
}
int NWNX_Administration_GetDebugValue(int type)
{
string sFunc = "GetDebugValue";
NWNX_PushArgumentInt(NWNX_Administration, sFunc, type);
NWNX_CallFunction(NWNX_Administration, sFunc);
return NWNX_GetReturnValueInt(NWNX_Administration, sFunc);
NWNXPushInt(type);
NWNXCall(NWNX_Administration, "GetDebugValue");
return NWNXPopInt();
}
void NWNX_Administration_SetDebugValue(int type, int state)
{
string sFunc = "SetDebugValue";
NWNX_PushArgumentInt(NWNX_Administration, sFunc, state);
NWNX_PushArgumentInt(NWNX_Administration, sFunc, type);
NWNX_CallFunction(NWNX_Administration, sFunc);
NWNXPushInt(state);
NWNXPushInt(type);
NWNXCall(NWNX_Administration, "SetDebugValue");
}
void NWNX_Administration_ReloadRules()
{
string sFunc = "ReloadRules";
NWNX_CallFunction(NWNX_Administration, sFunc);
NWNXCall(NWNX_Administration, "ReloadRules");
}
int NWNX_Administration_GetMinLevel()
{
NWNXCall(NWNX_Administration, "GetMinLevel");
return NWNXPopInt();
}
void NWNX_Administration_SetMinLevel(int nLevel)
{
NWNXPushInt(nLevel);
NWNXCall(NWNX_Administration, "SetMinLevel");
}
int NWNX_Administration_GetMaxLevel()
{
NWNXCall(NWNX_Administration, "GetMaxLevel");
return NWNXPopInt();
}
void NWNX_Administration_SetMaxLevel(int nLevel)
{
NWNXPushInt(nLevel);
NWNXCall(NWNX_Administration, "SetMaxLevel");
}

View File

@@ -2,7 +2,6 @@
/// @brief Allows the appearance and some other things of creatures to be overridden per player.
/// @{
/// @file nwnx_appearance.nss
#include "nwnx"
const string NWNX_Appearance = "NWNX_Appearance"; ///< @private
@@ -49,25 +48,18 @@ int NWNX_Appearance_GetOverride(object oPlayer, object oCreature, int nType);
void NWNX_Appearance_SetOverride(object oPlayer, object oCreature, int nType, int nValue)
{
string sFunc = "SetOverride";
NWNX_PushArgumentInt(NWNX_Appearance, sFunc, nValue);
NWNX_PushArgumentInt(NWNX_Appearance, sFunc, nType);
NWNX_PushArgumentObject(NWNX_Appearance, sFunc, oCreature);
NWNX_PushArgumentObject(NWNX_Appearance, sFunc, oPlayer);
NWNX_CallFunction(NWNX_Appearance, sFunc);
NWNXPushInt(nValue);
NWNXPushInt(nType);
NWNXPushObject(oCreature);
NWNXPushObject(oPlayer);
NWNXCall(NWNX_Appearance, "SetOverride");
}
int NWNX_Appearance_GetOverride(object oPlayer, object oCreature, int nType)
{
string sFunc = "GetOverride";
NWNX_PushArgumentInt(NWNX_Appearance, sFunc, nType);
NWNX_PushArgumentObject(NWNX_Appearance, sFunc, oCreature);
NWNX_PushArgumentObject(NWNX_Appearance, sFunc, oPlayer);
NWNX_CallFunction(NWNX_Appearance, sFunc);
return NWNX_GetReturnValueInt(NWNX_Appearance, sFunc);
NWNXPushInt(nType);
NWNXPushObject(oCreature);
NWNXPushObject(oPlayer);
NWNXCall(NWNX_Appearance, "GetOverride");
return NWNXPopInt();
}

View File

@@ -2,7 +2,6 @@
/// @brief Functions exposing additional area properties as well as creating transitions.
/// @{
/// @file nwnx_area.nss
#include "nwnx"
const string NWNX_Area = "NWNX_Area"; ///< @private
@@ -40,6 +39,25 @@ const int NWNX_AREA_COLOR_TYPE_SUN_AMBIENT = 2;
const int NWNX_AREA_COLOR_TYPE_SUN_DIFFUSE = 3;
/// @}
/// @brief A tile info struct
struct NWNX_Area_TileInfo
{
int nID; ///< The tile's ID
int nHeight; ///< The tile's height
int nOrientation; ///< The tile's orientation
int nGridX; ///< The tile's grid x position
int nGridY; ///< The tile's grid y position
};
/// @brief Area wind info struct
struct NWNX_Area_AreaWind
{
vector vDirection; ///< Wind's direction
float fMagnitude; ///< Wind's magnitude
float fYaw; ///< Wind's yaw
float fPitch; ///< Wind's pitch
};
/// @brief Gets the number of players in area.
/// @param area The area object.
/// @return The player count for the area.
@@ -223,328 +241,507 @@ int NWNX_Area_GetMusicIsPlaying(object oArea, int bBattleMusic = FALSE);
/// @sa NWNX_Object_SetTriggerGeometry() if you wish to draw the trigger as something other than a square.
object NWNX_Area_CreateGenericTrigger(object oArea, float fX, float fY, float fZ, string sTag = "", float fSize = 1.0f);
/// @brief Add oObject to the ExportGIT exclusion list, objects on this list won't be exported when NWNX_Area_ExportGIT() is called.
/// @param oObject The object to add
void NWNX_Area_AddObjectToExclusionList(object oObject);
/// @brief Remove oObject from the ExportGIT exclusion list.
/// @param oObject The object to add
void NWNX_Area_RemoveObjectFromExclusionList(object oObject);
/// @brief Export the .git file of oArea to the UserDirectory/nwnx folder, or to the location of sAlias.
/// @note Take care with local objects set on objects, they will likely not reference the same object after a server restart.
/// @param oArea The area to export the .git file of.
/// @param sFileName The filename, 16 characters or less and should be lowercase. If left blank the resref of oArea will be used.
/// @param bExportVarTable If TRUE, local variables set on oArea will be exported too.
/// @param bExportUUID If TRUE, the UUID of oArea will be exported, if it has one.
/// @param nObjectFilter One or more OBJECT_TYPE_* constants. These object will not be exported. For example OBJECT_TYPE_CREATURE | OBJECT_TYPE_DOOR
/// will not export creatures and doors. Use OBJECT_TYPE_ALL to filter all objects or 0 to export all objects.
/// @param sAlias The alias of the resource directory to add the .git file to. Default: UserDirectory/nwnx
/// @return TRUE if exported successfully, FALSE if not.
int NWNX_Area_ExportGIT(object oArea, string sFileName = "", int bExportVarTable = TRUE, int bExportUUID = TRUE, int nObjectFilter = 0, string sAlias = "NWNX");
/// @brief Get the tile info of the tile at [fTileX, fTileY] in oArea.
/// @param oArea The area name.
/// @param fTileX, fTileY The coordinates of the tile.
/// @return A NWNX_Area_TileInfo struct with tile info.
struct NWNX_Area_TileInfo NWNX_Area_GetTileInfo(object oArea, float fTileX, float fTileY);
/// @brief Export the .are file of oArea to the UserDirectory/nwnx folder, or to the location of sAlias.
/// @param oArea The area to export the .are file of.
/// @param sFileName The filename, 16 characters or less and should be lowercase. This will also be the resref of the area.
/// @param sNewName Optional new name of the area. Leave blank to use the current name.
/// @param sNewTag Optional new tag of the area. Leave blank to use the current tag.
/// @param sAlias The alias of the resource directory to add the .are file to. Default: UserDirectory/nwnx
/// @return TRUE if exported successfully, FALSE if not.
int NWNX_Area_ExportARE(object oArea, string sFileName, string sNewName = "", string sNewTag = "", string sAlias = "NWNX");
/// @brief Get the ambient sound playing in an area during the day.
/// @param oArea The area to get the sound of.
/// @return The ambient soundtrack. See ambientsound.2da.
int NWNX_Area_GetAmbientSoundDay(object oArea);
/// @brief Get the ambient sound playing in an area during the night.
/// @param oArea The area to get the sound of.
/// @return The ambient soundtrack. See ambientsound.2da.
int NWNX_Area_GetAmbientSoundNight(object oArea);
/// @brief Get the volume of the ambient sound playing in an area during the day.
/// @param oArea The area to get the sound volume of.
/// @return The volume.
int NWNX_Area_GetAmbientSoundDayVolume(object oArea);
/// @brief Get the volume of the ambient sound playing in an area during the night.
/// @param oArea The area to get the sound volume of.
/// @return The volume.
int NWNX_Area_GetAmbientSoundNightVolume(object oArea);
/// @brief Create a sound object.
/// @param oArea The area where to create the sound object.
/// @param vPosition The area position where to create the sound object.
/// @param sResRef The ResRef of the sound object.
/// @return The sound object.
object NWNX_Area_CreateSoundObject(object oArea, vector vPosition, string sResRef);
/// @brief Rotates an existing area, including all objects within (excluding PCs).
/// @note Functions while clients are in the area, but not recommended as tiles/walkmesh only updates on area load, and this may result in unexpected clientside results.
/// @param oArea The area to be rotated
/// @param nRotation How many 90 degrees clockwise to rotate (1-3).
void NWNX_Area_RotateArea(object oArea, int nRotation);
/// @brief Get the tile info of the tile at nIndex in the tile array.
/// @param oArea The area.
/// @param nIndex The index of the tile.
/// @return A NWNX_Area_TileInfo struct with tile info.
struct NWNX_Area_TileInfo NWNX_Area_GetTileInfoByTileIndex(object oArea, int nIndex);
/// @brief Check if there is a path between two positions in an area.
/// @note Does not care about doors or placeables, only checks tile path nodes.
/// @param oArea The area.
/// @param vStartPosition The start position.
/// @param vEndPosition The end position.
/// @param nMaxDepth The max depth of the DFS tree. A good value is AreaWidth * AreaHeight.
/// @return TRUE if there is a path between vStartPosition and vEndPosition, FALSE if not or on error.
int NWNX_Area_GetPathExists(object oArea, vector vStartPosition, vector vEndPosition, int nMaxDepth);
/// @brief Get oArea's flags, interior/underground etc.
/// @param oArea The area.
/// @return The raw flags bitmask or -1 on error.
int NWNX_Area_GetAreaFlags(object oArea);
/// @brief Set oArea's raw flags bitmask.
/// @note You'll have to do any bitwise operations yourself.
/// @note Requires clients to reload the area to get any updated flags.
/// @param oArea The area.
/// @param nFlags The flags.
void NWNX_Area_SetAreaFlags(object oArea, int nFlags);
/// @brief Get oArea's detailed win data.
/// @note vDirection returns [0.0, 0.0, 0.0] if not set previously with SetAreaWind nwscript function.
/// @param oArea The area.
struct NWNX_Area_AreaWind NWNX_Area_GetAreaWind(object oArea);
/// @brief Set the default discoverability mask for objects in an area.
/// @param oArea The area or OBJECT_INVALID to set a global mask for all areas. Per area masks will override the global mask.
/// @param nObjectTypes A mask of OBJECT_TYPE_* constants or OBJECT_TYPE_ALL for all suitable object types. Currently only works on Creatures, Doors (Hilite only), Items and Useable Placeables.
/// @param nMask A mask of OBJECT_UI_DISCOVERY_*
/// @param bForceUpdate If TRUE, will update the discovery mask of ALL objects in the area or module(if oArea == OBJECT_INVALID), according to the current mask. Use with care.
void NWNX_Area_SetDefaultObjectUiDiscoveryMask(object oArea, int nObjectTypes, int nMask, int bForceUpdate = FALSE);
/// @}
int NWNX_Area_GetNumberOfPlayersInArea(object area)
{
string sFunc = "GetNumberOfPlayersInArea";
NWNX_PushArgumentObject(NWNX_Area, sFunc, area);
NWNX_CallFunction(NWNX_Area, sFunc);
return NWNX_GetReturnValueInt(NWNX_Area, sFunc);
NWNXPushObject(area);
NWNXCall(NWNX_Area, "GetNumberOfPlayersInArea");
return NWNXPopInt();
}
object NWNX_Area_GetLastEntered(object area)
{
string sFunc = "GetLastEntered";
NWNX_PushArgumentObject(NWNX_Area, sFunc, area);
NWNX_CallFunction(NWNX_Area, sFunc);
return NWNX_GetReturnValueObject(NWNX_Area, sFunc);
NWNXPushObject(area);
NWNXCall(NWNX_Area, "GetLastEntered");
return NWNXPopObject();
}
object NWNX_Area_GetLastLeft(object area)
{
string sFunc = "GetLastLeft";
NWNX_PushArgumentObject(NWNX_Area, sFunc, area);
NWNX_CallFunction(NWNX_Area, sFunc);
return NWNX_GetReturnValueObject(NWNX_Area, sFunc);
NWNXPushObject(area);
NWNXCall(NWNX_Area, "GetLastLeft");
return NWNXPopObject();
}
int NWNX_Area_GetPVPSetting(object area)
{
string sFunc = "GetPVPSetting";
NWNX_PushArgumentObject(NWNX_Area, sFunc, area);
NWNX_CallFunction(NWNX_Area, sFunc);
return NWNX_GetReturnValueInt(NWNX_Area, sFunc);
NWNXPushObject(area);
NWNXCall(NWNX_Area, "GetPVPSetting");
return NWNXPopInt();
}
void NWNX_Area_SetPVPSetting(object area, int pvpSetting)
{
string sFunc = "SetPVPSetting";
NWNX_PushArgumentInt(NWNX_Area, sFunc, pvpSetting);
NWNX_PushArgumentObject(NWNX_Area, sFunc, area);
NWNX_CallFunction(NWNX_Area, sFunc);
NWNXPushInt(pvpSetting);
NWNXPushObject(area);
NWNXCall(NWNX_Area, "SetPVPSetting");
}
int NWNX_Area_GetAreaSpotModifier(object area)
{
string sFunc = "GetAreaSpotModifier";
NWNX_PushArgumentObject(NWNX_Area, sFunc, area);
NWNX_CallFunction(NWNX_Area, sFunc);
return NWNX_GetReturnValueInt(NWNX_Area, sFunc);
NWNXPushObject(area);
NWNXCall(NWNX_Area, "GetAreaSpotModifier");
return NWNXPopInt();
}
void NWNX_Area_SetAreaSpotModifier(object area, int spotModifier)
{
string sFunc = "SetAreaSpotModifier";
NWNX_PushArgumentInt(NWNX_Area, sFunc, spotModifier);
NWNX_PushArgumentObject(NWNX_Area, sFunc, area);
NWNX_CallFunction(NWNX_Area, sFunc);
NWNXPushInt(spotModifier);
NWNXPushObject(area);
NWNXCall(NWNX_Area, "SetAreaSpotModifier");
}
int NWNX_Area_GetAreaListenModifier(object area)
{
string sFunc = "GetAreaListenModifier";
NWNX_PushArgumentObject(NWNX_Area, sFunc, area);
NWNX_CallFunction(NWNX_Area, sFunc);
return NWNX_GetReturnValueInt(NWNX_Area, sFunc);
NWNXPushObject(area);
NWNXCall(NWNX_Area, "GetAreaListenModifier");
return NWNXPopInt();
}
void NWNX_Area_SetAreaListenModifier(object area, int listenModifier)
{
string sFunc = "SetAreaListenModifier";
NWNX_PushArgumentInt(NWNX_Area, sFunc, listenModifier);
NWNX_PushArgumentObject(NWNX_Area, sFunc, area);
NWNX_CallFunction(NWNX_Area, sFunc);
NWNXPushInt(listenModifier);
NWNXPushObject(area);
NWNXCall(NWNX_Area, "SetAreaListenModifier");
}
int NWNX_Area_GetNoRestingAllowed(object area)
{
string sFunc = "GetNoRestingAllowed";
NWNX_PushArgumentObject(NWNX_Area, sFunc, area);
NWNX_CallFunction(NWNX_Area, sFunc);
return NWNX_GetReturnValueInt(NWNX_Area, sFunc);
NWNXPushObject(area);
NWNXCall(NWNX_Area, "GetNoRestingAllowed");
return NWNXPopInt();
}
void NWNX_Area_SetNoRestingAllowed(object area, int bNoRestingAllowed)
{
string sFunc = "SetNoRestingAllowed";
NWNX_PushArgumentInt(NWNX_Area, sFunc, bNoRestingAllowed);
NWNX_PushArgumentObject(NWNX_Area, sFunc, area);
NWNX_CallFunction(NWNX_Area, sFunc);
NWNXPushInt(bNoRestingAllowed);
NWNXPushObject(area);
NWNXCall(NWNX_Area, "SetNoRestingAllowed");
}
int NWNX_Area_GetWindPower(object area)
{
string sFunc = "GetWindPower";
NWNX_PushArgumentObject(NWNX_Area, sFunc, area);
NWNX_CallFunction(NWNX_Area, sFunc);
return NWNX_GetReturnValueInt(NWNX_Area, sFunc);
NWNXPushObject(area);
NWNXCall(NWNX_Area, "GetWindPower");
return NWNXPopInt();
}
void NWNX_Area_SetWindPower(object area, int windPower)
{
string sFunc = "SetWindPower";
NWNX_PushArgumentInt(NWNX_Area, sFunc, windPower);
NWNX_PushArgumentObject(NWNX_Area, sFunc, area);
NWNX_CallFunction(NWNX_Area, sFunc);
NWNXPushInt(windPower);
NWNXPushObject(area);
NWNXCall(NWNX_Area, "SetWindPower");
}
int NWNX_Area_GetWeatherChance(object area, int type)
{
string sFunc = "GetWeatherChance";
NWNX_PushArgumentInt(NWNX_Area, sFunc, type);
NWNX_PushArgumentObject(NWNX_Area, sFunc, area);
NWNX_CallFunction(NWNX_Area, sFunc);
return NWNX_GetReturnValueInt(NWNX_Area, sFunc);
NWNXPushInt(type);
NWNXPushObject(area);
NWNXCall(NWNX_Area, "GetWeatherChance");
return NWNXPopInt();
}
void NWNX_Area_SetWeatherChance(object area, int type, int chance)
{
string sFunc = "SetWeatherChance";
NWNX_PushArgumentInt(NWNX_Area, sFunc, chance);
NWNX_PushArgumentInt(NWNX_Area, sFunc, type);
NWNX_PushArgumentObject(NWNX_Area, sFunc, area);
NWNX_CallFunction(NWNX_Area, sFunc);
NWNXPushInt(chance);
NWNXPushInt(type);
NWNXPushObject(area);
NWNXCall(NWNX_Area, "SetWeatherChance");
}
float NWNX_Area_GetFogClipDistance(object area)
{
string sFunc = "GetFogClipDistance";
NWNX_PushArgumentObject(NWNX_Area, sFunc, area);
NWNX_CallFunction(NWNX_Area, sFunc);
return NWNX_GetReturnValueFloat(NWNX_Area, sFunc);
NWNXPushObject(area);
NWNXCall(NWNX_Area, "GetFogClipDistance");
return NWNXPopFloat();
}
void NWNX_Area_SetFogClipDistance(object area, float distance)
{
string sFunc = "SetFogClipDistance";
NWNX_PushArgumentFloat(NWNX_Area, sFunc, distance);
NWNX_PushArgumentObject(NWNX_Area, sFunc, area);
NWNX_CallFunction(NWNX_Area, sFunc);
NWNXPushFloat(distance);
NWNXPushObject(area);
NWNXCall(NWNX_Area, "SetFogClipDistance");
}
int NWNX_Area_GetShadowOpacity(object area)
{
string sFunc = "GetShadowOpacity";
NWNX_PushArgumentObject(NWNX_Area, sFunc, area);
NWNX_CallFunction(NWNX_Area, sFunc);
return NWNX_GetReturnValueInt(NWNX_Area, sFunc);
NWNXPushObject(area);
NWNXCall(NWNX_Area, "GetShadowOpacity");
return NWNXPopInt();
}
void NWNX_Area_SetShadowOpacity(object area, int shadowOpacity)
{
string sFunc = "SetShadowOpacity";
NWNX_PushArgumentInt(NWNX_Area, sFunc, shadowOpacity);
NWNX_PushArgumentObject(NWNX_Area, sFunc, area);
NWNX_CallFunction(NWNX_Area, sFunc);
NWNXPushInt(shadowOpacity);
NWNXPushObject(area);
NWNXCall(NWNX_Area, "SetShadowOpacity");
}
int NWNX_Area_GetDayNightCycle(object area)
{
string sFunc = "GetDayNightCycle";
NWNX_PushArgumentObject(NWNX_Area, sFunc, area);
NWNX_CallFunction(NWNX_Area, sFunc);
return NWNX_GetReturnValueInt(NWNX_Area, sFunc);
NWNXPushObject(area);
NWNXCall(NWNX_Area, "GetDayNightCycle");
return NWNXPopInt();
}
void NWNX_Area_SetDayNightCycle(object area, int type)
{
string sFunc = "SetDayNightCycle";
NWNX_PushArgumentInt(NWNX_Area, sFunc, type);
NWNX_PushArgumentObject(NWNX_Area, sFunc, area);
NWNX_CallFunction(NWNX_Area, sFunc);
NWNXPushInt(type);
NWNXPushObject(area);
NWNXCall(NWNX_Area, "SetDayNightCycle");
}
int NWNX_Area_GetSunMoonColors(object area, int type)
{
string sFunc = "GetSunMoonColors";
NWNX_PushArgumentInt(NWNX_Area, sFunc, type);
NWNX_PushArgumentObject(NWNX_Area, sFunc, area);
NWNX_CallFunction(NWNX_Area, sFunc);
return NWNX_GetReturnValueInt(NWNX_Area, sFunc);
NWNXPushInt(type);
NWNXPushObject(area);
NWNXCall(NWNX_Area, "GetSunMoonColors");
return NWNXPopInt();
}
void NWNX_Area_SetSunMoonColors(object area, int type, int color)
{
string sFunc = "SetSunMoonColors";
NWNX_PushArgumentInt(NWNX_Area, sFunc, color);
NWNX_PushArgumentInt(NWNX_Area, sFunc, type);
NWNX_PushArgumentObject(NWNX_Area, sFunc, area);
NWNX_CallFunction(NWNX_Area, sFunc);
NWNXPushInt(color);
NWNXPushInt(type);
NWNXPushObject(area);
NWNXCall(NWNX_Area, "SetSunMoonColors");
}
object NWNX_Area_CreateTransition(object area, object target, float x, float y, float z, float size = 2.0f, string tag="")
{
string sFunc = "CreateTransition";
NWNX_PushArgumentString(NWNX_Area, sFunc, tag);
NWNX_PushArgumentFloat(NWNX_Area, sFunc, size);
NWNX_PushArgumentFloat(NWNX_Area, sFunc, z);
NWNX_PushArgumentFloat(NWNX_Area, sFunc, y);
NWNX_PushArgumentFloat(NWNX_Area, sFunc, x);
NWNX_PushArgumentObject(NWNX_Area, sFunc, target);
NWNX_PushArgumentObject(NWNX_Area, sFunc, area);
NWNX_CallFunction(NWNX_Area, sFunc);
return NWNX_GetReturnValueObject(NWNX_Area, sFunc);
NWNXPushString(tag);
NWNXPushFloat(size);
NWNXPushFloat(z);
NWNXPushFloat(y);
NWNXPushFloat(x);
NWNXPushObject(target);
NWNXPushObject(area);
NWNXCall(NWNX_Area, "CreateTransition");
return NWNXPopObject();
}
int NWNX_Area_GetTileAnimationLoop(object oArea, float fTileX, float fTileY, int nAnimLoop)
{
string sFunc = "GetTileAnimationLoop";
NWNXPushInt(nAnimLoop);
NWNXPushFloat(fTileY);
NWNXPushFloat(fTileX);
NWNXPushObject(oArea);
NWNX_PushArgumentInt(NWNX_Area, sFunc, nAnimLoop);
NWNX_PushArgumentFloat(NWNX_Area, sFunc, fTileY);
NWNX_PushArgumentFloat(NWNX_Area, sFunc, fTileX);
NWNX_PushArgumentObject(NWNX_Area, sFunc, oArea);
NWNX_CallFunction(NWNX_Area, sFunc);
return NWNX_GetReturnValueInt(NWNX_Area, sFunc);
NWNXCall(NWNX_Area, "GetTileAnimationLoop");
return NWNXPopInt();
}
void NWNX_Area_SetTileAnimationLoop(object oArea, float fTileX, float fTileY, int nAnimLoop, int bEnabled)
{
string sFunc = "SetTileAnimationLoop";
NWNX_PushArgumentInt(NWNX_Area, sFunc, bEnabled);
NWNX_PushArgumentInt(NWNX_Area, sFunc, nAnimLoop);
NWNX_PushArgumentFloat(NWNX_Area, sFunc, fTileY);
NWNX_PushArgumentFloat(NWNX_Area, sFunc, fTileX);
NWNX_PushArgumentObject(NWNX_Area, sFunc, oArea);
NWNX_CallFunction(NWNX_Area, sFunc);
NWNXPushInt(bEnabled);
NWNXPushInt(nAnimLoop);
NWNXPushFloat(fTileY);
NWNXPushFloat(fTileX);
NWNXPushObject(oArea);
NWNXCall(NWNX_Area, "SetTileAnimationLoop");
}
string NWNX_Area_GetTileModelResRef(object oArea, float fTileX, float fTileY)
{
string sFunc = "GetTileModelResRef";
NWNX_PushArgumentFloat(NWNX_Area, sFunc, fTileY);
NWNX_PushArgumentFloat(NWNX_Area, sFunc, fTileX);
NWNX_PushArgumentObject(NWNX_Area, sFunc, oArea);
NWNX_CallFunction(NWNX_Area, sFunc);
return NWNX_GetReturnValueString(NWNX_Area, sFunc);
NWNXPushFloat(fTileY);
NWNXPushFloat(fTileX);
NWNXPushObject(oArea);
NWNXCall(NWNX_Area, "GetTileModelResRef");
return NWNXPopString();
}
int NWNX_Area_TestDirectLine(object oArea, float fStartX, float fStartY, float fEndX, float fEndY, float fPerSpace, float fHeight, int bIgnoreDoors=FALSE)
{
string sFunc = "TestDirectLine";
NWNX_PushArgumentInt(NWNX_Area, sFunc, bIgnoreDoors);
NWNX_PushArgumentFloat(NWNX_Area, sFunc, fHeight);
NWNX_PushArgumentFloat(NWNX_Area, sFunc, fPerSpace);
NWNX_PushArgumentFloat(NWNX_Area, sFunc, fEndY);
NWNX_PushArgumentFloat(NWNX_Area, sFunc, fEndX);
NWNX_PushArgumentFloat(NWNX_Area, sFunc, fStartY);
NWNX_PushArgumentFloat(NWNX_Area, sFunc, fStartX);
NWNX_PushArgumentObject(NWNX_Area, sFunc, oArea);
NWNX_CallFunction(NWNX_Area, sFunc);
return NWNX_GetReturnValueInt(NWNX_Area, sFunc);
NWNXPushInt(bIgnoreDoors);
NWNXPushFloat(fHeight);
NWNXPushFloat(fPerSpace);
NWNXPushFloat(fEndY);
NWNXPushFloat(fEndX);
NWNXPushFloat(fStartY);
NWNXPushFloat(fStartX);
NWNXPushObject(oArea);
NWNXCall(NWNX_Area, "TestDirectLine");
return NWNXPopInt();
}
int NWNX_Area_GetMusicIsPlaying(object oArea, int bBattleMusic = FALSE)
{
string sFunc = "GetMusicIsPlaying";
NWNX_PushArgumentInt(NWNX_Area, sFunc, bBattleMusic);
NWNX_PushArgumentObject(NWNX_Area, sFunc, oArea);
NWNX_CallFunction(NWNX_Area, sFunc);
return NWNX_GetReturnValueInt(NWNX_Area, sFunc);
NWNXPushInt(bBattleMusic);
NWNXPushObject(oArea);
NWNXCall(NWNX_Area, "GetMusicIsPlaying");
return NWNXPopInt();
}
object NWNX_Area_CreateGenericTrigger(object oArea, float fX, float fY, float fZ, string sTag = "", float fSize = 1.0f)
{
string sFunc = "CreateGenericTrigger";
NWNX_PushArgumentFloat(NWNX_Area, sFunc, fSize);
NWNX_PushArgumentString(NWNX_Area, sFunc, sTag);
NWNX_PushArgumentFloat(NWNX_Area, sFunc, fZ);
NWNX_PushArgumentFloat(NWNX_Area, sFunc, fY);
NWNX_PushArgumentFloat(NWNX_Area, sFunc, fX);
NWNX_PushArgumentObject(NWNX_Area, sFunc, oArea);
NWNX_CallFunction(NWNX_Area, sFunc);
return NWNX_GetReturnValueObject(NWNX_Area, sFunc);
NWNXPushFloat(fSize);
NWNXPushString(sTag);
NWNXPushFloat(fZ);
NWNXPushFloat(fY);
NWNXPushFloat(fX);
NWNXPushObject(oArea);
NWNXCall(NWNX_Area, "CreateGenericTrigger");
return NWNXPopObject();
}
void NWNX_Area_AddObjectToExclusionList(object oObject)
{
NWNXPushObject(oObject);
NWNXCall(NWNX_Area, "AddObjectToExclusionList");
}
void NWNX_Area_RemoveObjectFromExclusionList(object oObject)
{
NWNXPushObject(oObject);
NWNXCall(NWNX_Area, "RemoveObjectFromExclusionList");
}
int NWNX_Area_ExportGIT(object oArea, string sFileName = "", int bExportVarTable = TRUE, int bExportUUID = TRUE, int nObjectFilter = 0, string sAlias = "NWNX")
{
NWNXPushString(sAlias);
NWNXPushInt(nObjectFilter);
NWNXPushInt(bExportUUID);
NWNXPushInt(bExportVarTable);
NWNXPushString(sFileName);
NWNXPushObject(oArea);
NWNXCall(NWNX_Area, "ExportGIT");
return NWNXPopInt();
}
struct NWNX_Area_TileInfo NWNX_Area_GetTileInfo(object oArea, float fTileX, float fTileY)
{
NWNXPushFloat(fTileY);
NWNXPushFloat(fTileX);
NWNXPushObject(oArea);
NWNXCall(NWNX_Area, "GetTileInfo");
struct NWNX_Area_TileInfo str;
str.nGridY = NWNXPopInt();
str.nGridX = NWNXPopInt();
str.nOrientation = NWNXPopInt();
str.nHeight = NWNXPopInt();
str.nID = NWNXPopInt();
return str;
}
int NWNX_Area_ExportARE(object oArea, string sFileName, string sNewName = "", string sNewTag = "", string sAlias = "NWNX")
{
NWNXPushString(sAlias);
NWNXPushString(sNewTag);
NWNXPushString(sNewName);
NWNXPushString(sFileName);
NWNXPushObject(oArea);
NWNXCall(NWNX_Area, "ExportARE");
return NWNXPopInt();
}
int NWNX_Area_GetAmbientSoundDay(object oArea)
{
NWNXPushObject(oArea);
NWNXCall(NWNX_Area, "GetAmbientSoundDay");
return NWNXPopInt();
}
int NWNX_Area_GetAmbientSoundNight(object oArea)
{
NWNXPushObject(oArea);
NWNXCall(NWNX_Area, "GetAmbientSoundNight");
return NWNXPopInt();
}
int NWNX_Area_GetAmbientSoundDayVolume(object oArea)
{
NWNXPushObject(oArea);
NWNXCall(NWNX_Area, "GetAmbientSoundDayVolume");
return NWNXPopInt();
}
int NWNX_Area_GetAmbientSoundNightVolume(object oArea)
{
NWNXPushObject(oArea);
NWNXCall(NWNX_Area, "GetAmbientSoundNightVolume");
return NWNXPopInt();
}
object NWNX_Area_CreateSoundObject(object oArea, vector vPosition, string sResRef)
{
NWNXPushString(sResRef);
NWNXPushVector(vPosition);
NWNXPushObject(oArea);
NWNXCall(NWNX_Area, "CreateSoundObject");
return NWNXPopObject();
}
void NWNX_Area_RotateArea(object oArea, int nRotation)
{
NWNXPushInt(nRotation);
NWNXPushObject(oArea);
NWNXCall(NWNX_Area, "RotateArea");
}
struct NWNX_Area_TileInfo NWNX_Area_GetTileInfoByTileIndex(object oArea, int nIndex)
{
NWNXPushInt(nIndex);
NWNXPushObject(oArea);
NWNXCall(NWNX_Area, "GetTileInfoByTileIndex");
struct NWNX_Area_TileInfo str;
str.nGridY = NWNXPopInt();
str.nGridX = NWNXPopInt();
str.nOrientation = NWNXPopInt();
str.nHeight = NWNXPopInt();
str.nID = NWNXPopInt();
return str;
}
int NWNX_Area_GetPathExists(object oArea, vector vStartPosition, vector vEndPosition, int nMaxDepth)
{
NWNXPushInt(nMaxDepth);
NWNXPushVector(vEndPosition);
NWNXPushVector(vStartPosition);
NWNXPushObject(oArea);
NWNXCall(NWNX_Area, "GetPathExists");
return NWNXPopInt();
}
int NWNX_Area_GetAreaFlags(object oArea)
{
NWNXPushObject(oArea);
NWNXCall(NWNX_Area, "GetAreaFlags");
return NWNXPopInt();
}
void NWNX_Area_SetAreaFlags(object oArea, int nFlags)
{
NWNXPushInt(nFlags);
NWNXPushObject(oArea);
NWNXCall(NWNX_Area, "SetAreaFlags");
}
struct NWNX_Area_AreaWind NWNX_Area_GetAreaWind(object oArea)
{
struct NWNX_Area_AreaWind data;
NWNXPushObject(oArea);
NWNXCall(NWNX_Area, "GetAreaWind");
data.fPitch = NWNXPopFloat();
data.fYaw = NWNXPopFloat();
data.fMagnitude = NWNXPopFloat();
data.vDirection = NWNXPopVector();
return data;
}
void NWNX_Area_SetDefaultObjectUiDiscoveryMask(object oArea, int nObjectTypes, int nMask, int bForceUpdate = FALSE)
{
NWNXPushInt(bForceUpdate);
NWNXPushInt(nMask);
NWNXPushInt(nObjectTypes);
NWNXPushObject(oArea);
NWNXCall(NWNX_Area, "SetDefaultObjectUiDiscoveryMask");
}

View File

@@ -2,7 +2,6 @@
/// @brief Functions related to chat.
/// @{
/// @file nwnx_chat.nss
#include "nwnx"
const string NWNX_Chat = "NWNX_Chat"; ///< @private
@@ -80,79 +79,61 @@ float NWNX_Chat_GetChatHearingDistance(object listener = OBJECT_INVALID, int cha
int NWNX_Chat_SendMessage(int channel, string message, object sender = OBJECT_SELF, object target = OBJECT_INVALID)
{
string sFunc = "SendMessage";
NWNX_PushArgumentObject(NWNX_Chat, sFunc, target);
NWNX_PushArgumentObject(NWNX_Chat, sFunc, sender);
NWNX_PushArgumentString(NWNX_Chat, sFunc, message);
NWNX_PushArgumentInt(NWNX_Chat, sFunc, channel);
NWNX_CallFunction(NWNX_Chat, sFunc);
return NWNX_GetReturnValueInt(NWNX_Chat, sFunc);
NWNXPushObject(target);
NWNXPushObject(sender);
NWNXPushString(message);
NWNXPushInt(channel);
NWNXCall(NWNX_Chat, "SendMessage");
return NWNXPopInt();
}
void NWNX_Chat_RegisterChatScript(string script)
{
string sFunc = "RegisterChatScript";
NWNX_PushArgumentString(NWNX_Chat, sFunc, script);
NWNX_CallFunction(NWNX_Chat, sFunc);
NWNXPushString(script);
NWNXCall(NWNX_Chat, "RegisterChatScript");
}
void NWNX_Chat_SkipMessage()
{
string sFunc = "SkipMessage";
NWNX_CallFunction(NWNX_Chat, sFunc);
NWNXCall(NWNX_Chat, "SkipMessage");
}
int NWNX_Chat_GetChannel()
{
string sFunc = "GetChannel";
NWNX_CallFunction(NWNX_Chat, sFunc);
return NWNX_GetReturnValueInt(NWNX_Chat, sFunc);
NWNXCall(NWNX_Chat, "GetChannel");
return NWNXPopInt();
}
string NWNX_Chat_GetMessage()
{
string sFunc = "GetMessage";
NWNX_CallFunction(NWNX_Chat, sFunc);
return NWNX_GetReturnValueString(NWNX_Chat, sFunc);
NWNXCall(NWNX_Chat, "GetMessage");
return NWNXPopString();
}
object NWNX_Chat_GetSender()
{
string sFunc = "GetSender";
NWNX_CallFunction(NWNX_Chat, sFunc);
return NWNX_GetReturnValueObject(NWNX_Chat, sFunc);
NWNXCall(NWNX_Chat, "GetSender");
return NWNXPopObject();
}
object NWNX_Chat_GetTarget()
{
string sFunc = "GetTarget";
NWNX_CallFunction(NWNX_Chat, sFunc);
return NWNX_GetReturnValueObject(NWNX_Chat, sFunc);
NWNXCall(NWNX_Chat, "GetTarget");
return NWNXPopObject();
}
void NWNX_Chat_SetChatHearingDistance(float distance, object listener = OBJECT_INVALID, int channel = NWNX_CHAT_CHANNEL_PLAYER_TALK)
{
string sFunc = "SetChatHearingDistance";
NWNX_PushArgumentInt(NWNX_Chat, sFunc, channel);
NWNX_PushArgumentObject(NWNX_Chat, sFunc, listener);
NWNX_PushArgumentFloat(NWNX_Chat, sFunc, distance);
NWNX_CallFunction(NWNX_Chat, sFunc);
NWNXPushInt(channel);
NWNXPushObject(listener);
NWNXPushFloat(distance);
NWNXCall(NWNX_Chat, "SetChatHearingDistance");
}
float NWNX_Chat_GetChatHearingDistance(object listener = OBJECT_INVALID, int channel = NWNX_CHAT_CHANNEL_PLAYER_TALK)
{
string sFunc = "GetChatHearingDistance";
NWNX_PushArgumentInt(NWNX_Chat, sFunc, channel);
NWNX_PushArgumentObject(NWNX_Chat, sFunc, listener);
NWNX_CallFunction(NWNX_Chat, sFunc);
return NWNX_GetReturnValueFloat(NWNX_Chat, sFunc);
NWNXPushInt(channel);
NWNXPushObject(listener);
NWNXCall(NWNX_Chat, "GetChatHearingDistance");
return NWNXPopFloat();
}

View File

@@ -1,17 +1,22 @@
/// @ingroup nwnx
/// @addtogroup consts NWNX Constants
/// @brief Provides various NWScript <-> NWNX Constants Translation Table functions
/// @brief Provides various NWScript <-> Engine Constants Translation Table functions
/// @{
/// @file nwnx_consts.nss
/// @brief Translates ANIMATION_LOOPING_* and ANIMATION_FIREFORGET_* constants to their NWNX equivalent.
/// @brief Translates ANIMATION_LOOPING_* and ANIMATION_FIREFORGET_* constants to their engine equivalent.
/// @param nAnimation The nwn animation constant
/// @return The NWNX equivalent of the constant
/// @return The engine equivalent of the constant
int NWNX_Consts_TranslateNWScriptAnimation(int nAnimation);
/// @brief Translates OBJECT_TYPE_* constants to their NWNX equivalent.
/// @brief Translates engine animation constants to their ANIMATION_LOOPING_* and ANIMATION_FIREFORGET_* equivalent.
/// @param nAnimation The engine animation constant
/// @return The NWScript equivalent of the constant or -1 if a nwscript equivalent doesn't exist
int NWNX_Consts_TranslateEngineAnimation(int nAnimation);
/// @brief Translates OBJECT_TYPE_* constants to their engine equivalent.
/// @param nObjectType The nwn object type
/// @return The NWNX equivalent of the constant
/// @return The engine equivalent of the constant
int NWNX_Consts_TranslateNWScriptObjectType(int nObjectType);
@@ -85,6 +90,76 @@ int NWNX_Consts_TranslateNWScriptAnimation(int nAnimation)
return nAnimation;
}
int NWNX_Consts_TranslateEngineAnimation(int nAnimation)
{
switch (nAnimation)
{
case 0: nAnimation = ANIMATION_LOOPING_PAUSE; break;
case 52: nAnimation = ANIMATION_LOOPING_PAUSE2; break;
case 30: nAnimation = ANIMATION_LOOPING_LISTEN; break;
case 32: nAnimation = ANIMATION_LOOPING_MEDITATE; break;
case 33: nAnimation = ANIMATION_LOOPING_WORSHIP; break;
case 48: nAnimation = ANIMATION_LOOPING_LOOK_FAR; break;
case 36: nAnimation = ANIMATION_LOOPING_SIT_CHAIR; break;
case 47: nAnimation = ANIMATION_LOOPING_SIT_CROSS; break;
case 38: nAnimation = ANIMATION_LOOPING_TALK_NORMAL; break;
case 39: nAnimation = ANIMATION_LOOPING_TALK_PLEADING; break;
case 40: nAnimation = ANIMATION_LOOPING_TALK_FORCEFUL; break;
case 41: nAnimation = ANIMATION_LOOPING_TALK_LAUGHING; break;
case 59: nAnimation = ANIMATION_LOOPING_GET_LOW; break;
case 60: nAnimation = ANIMATION_LOOPING_GET_MID; break;
case 57: nAnimation = ANIMATION_LOOPING_PAUSE_TIRED; break;
case 58: nAnimation = ANIMATION_LOOPING_PAUSE_DRUNK; break;
case 6: nAnimation = ANIMATION_LOOPING_DEAD_FRONT; break;
case 8: nAnimation = ANIMATION_LOOPING_DEAD_BACK; break;
case 15: nAnimation = ANIMATION_LOOPING_CONJURE1; break;
case 16: nAnimation = ANIMATION_LOOPING_CONJURE2; break;
case 93: nAnimation = ANIMATION_LOOPING_SPASM; break;
case 97: nAnimation = ANIMATION_LOOPING_CUSTOM1; break;
case 98: nAnimation = ANIMATION_LOOPING_CUSTOM2; break;
case 101: nAnimation = ANIMATION_LOOPING_CUSTOM3; break;
case 102: nAnimation = ANIMATION_LOOPING_CUSTOM4; break;
case 103: nAnimation = ANIMATION_LOOPING_CUSTOM5; break;
case 104: nAnimation = ANIMATION_LOOPING_CUSTOM6; break;
case 105: nAnimation = ANIMATION_LOOPING_CUSTOM7; break;
case 106: nAnimation = ANIMATION_LOOPING_CUSTOM8; break;
case 107: nAnimation = ANIMATION_LOOPING_CUSTOM9; break;
case 108: nAnimation = ANIMATION_LOOPING_CUSTOM10; break;
case 109: nAnimation = ANIMATION_LOOPING_CUSTOM11; break;
case 110: nAnimation = ANIMATION_LOOPING_CUSTOM12; break;
case 111: nAnimation = ANIMATION_LOOPING_CUSTOM13; break;
case 112: nAnimation = ANIMATION_LOOPING_CUSTOM14; break;
case 113: nAnimation = ANIMATION_LOOPING_CUSTOM15; break;
case 114: nAnimation = ANIMATION_LOOPING_CUSTOM16; break;
case 115: nAnimation = ANIMATION_LOOPING_CUSTOM17; break;
case 116: nAnimation = ANIMATION_LOOPING_CUSTOM18; break;
case 117: nAnimation = ANIMATION_LOOPING_CUSTOM19; break;
case 118: nAnimation = ANIMATION_LOOPING_CUSTOM20; break;
case 119: nAnimation = ANIMATION_MOUNT1; break;
case 120: nAnimation = ANIMATION_DISMOUNT1; break;
case 53: nAnimation = ANIMATION_FIREFORGET_HEAD_TURN_LEFT; break;
case 54: nAnimation = ANIMATION_FIREFORGET_HEAD_TURN_RIGHT; break;
case 55: nAnimation = ANIMATION_FIREFORGET_PAUSE_SCRATCH_HEAD; break;
case 56: nAnimation = ANIMATION_FIREFORGET_PAUSE_BORED; break;
case 34: nAnimation = ANIMATION_FIREFORGET_SALUTE; break;
case 35: nAnimation = ANIMATION_FIREFORGET_BOW; break;
case 37: nAnimation = ANIMATION_FIREFORGET_STEAL; break;
case 29: nAnimation = ANIMATION_FIREFORGET_GREETING; break;
case 28: nAnimation = ANIMATION_FIREFORGET_TAUNT; break;
case 44: nAnimation = ANIMATION_FIREFORGET_VICTORY1; break;
case 45: nAnimation = ANIMATION_FIREFORGET_VICTORY2; break;
case 46: nAnimation = ANIMATION_FIREFORGET_VICTORY3; break;
case 71: nAnimation = ANIMATION_FIREFORGET_READ; break;
case 70: nAnimation = ANIMATION_FIREFORGET_DRINK; break;
case 90: nAnimation = ANIMATION_FIREFORGET_DODGE_SIDE; break;
case 91: nAnimation = ANIMATION_FIREFORGET_DODGE_DUCK; break;
case 23: nAnimation = ANIMATION_FIREFORGET_SPASM; break;
default: nAnimation = -1; break;
}
return nAnimation;
}
int NWNX_Consts_TranslateNWScriptObjectType(int nObjectType)
{
switch(nObjectType)

21
_module/nss/nwnx_core.nss Normal file
View File

@@ -0,0 +1,21 @@
/// @addtogroup nwnx NWNX
/// @brief Core NWNX Functions.
/// @{
/// @file nwnx_core.nss
const string NWNX_Core = "NWNX_Core"; ///< @private
/// @brief Determines if the given plugin exists and is enabled.
/// @param sPlugin The name of the plugin to check. This is the case sensitive plugin name as used by NWNXCall
/// @note Example usage: NWNX_PluginExists("NWNX_Creature");
/// @return TRUE if the plugin exists and is enabled, otherwise FALSE.
int NWNX_Core_PluginExists(string sPlugin);
/// @}
int NWNX_Core_PluginExists(string sPlugin)
{
NWNXPushString(sPlugin);
NWNXCall(NWNX_Core, "PluginExists");
return NWNXPopInt();
}

File diff suppressed because it is too large Load Diff

View File

@@ -2,7 +2,6 @@
/// @brief Run a script before damage and attack events allowing for modification. Includes function to arbitrarily apply damage.
/// @{
/// @file nwnx_damage.nss
#include "nwnx"
const string NWNX_Damage = "NWNX_Damage"; ///< @private
@@ -24,6 +23,26 @@ struct NWNX_Damage_DamageEventData
int iPositive; ///< Positive damage
int iSonic; ///< Sonic damage
int iBase; ///< Base damage
int iCustom1; ///< Custom1 damage
int iCustom2; ///< Custom2 damage
int iCustom3; ///< Custom3 damage
int iCustom4; ///< Custom4 damage
int iCustom5; ///< Custom5 damage
int iCustom6; ///< Custom6 damage
int iCustom7; ///< Custom7 damage
int iCustom8; ///< Custom8 damage
int iCustom9; ///< Custom9 damage
int iCustom10; ///< Custom10 damage
int iCustom11; ///< Custom11 damage
int iCustom12; ///< Custom12 damage
int iCustom13; ///< Custom13 damage
int iCustom14; ///< Custom14 damage
int iCustom15; ///< Custom15 damage
int iCustom16; ///< Custom16 damage
int iCustom17; ///< Custom17 damage
int iCustom18; ///< Custom18 damage
int iCustom19; ///< Custom19 damage
int iSpellId; ///< The spell id associated with the damage or -1 if not known.
};
/// @struct NWNX_Damage_AttackEventData
@@ -44,10 +63,33 @@ struct NWNX_Damage_AttackEventData
int iPositive; ///< Positive damage
int iSonic; ///< Sonic damage
int iBase; ///< Base damage
int iCustom1; ///< Custom1 damage
int iCustom2; ///< Custom2 damage
int iCustom3; ///< Custom3 damage
int iCustom4; ///< Custom4 damage
int iCustom5; ///< Custom5 damage
int iCustom6; ///< Custom6 damage
int iCustom7; ///< Custom7 damage
int iCustom8; ///< Custom8 damage
int iCustom9; ///< Custom9 damage
int iCustom10; ///< Custom10 damage
int iCustom11; ///< Custom11 damage
int iCustom12; ///< Custom12 damage
int iCustom13; ///< Custom13 damage
int iCustom14; ///< Custom14 damage
int iCustom15; ///< Custom15 damage
int iCustom16; ///< Custom16 damage
int iCustom17; ///< Custom17 damage
int iCustom18; ///< Custom18 damage
int iCustom19; ///< Custom19 damage
int iAttackNumber; ///< 1-based index of the attack in current combat round
int iAttackResult; ///< 1=hit, 3=critical hit, 4=miss, 8=concealed
int iAttackType; ///< 1=main hand, 2=offhand, 3-5=creature, 6=haste
int iSneakAttack; ///< 0=neither, 1=sneak attack, 2=death attack, 3=both
int iAttackResult; ///< 1=hit, 2=parried, 3=critical hit, 4=miss, 5=resisted, 7=automatic hit, 8=concealed, 9=miss chance, 10=devastating crit
int iWeaponAttackType; ///< 1=main hand, 2=offhand, 3-5=creature, 6=extra(haste), 7=unarmed, 8=unarmed extra
int iSneakAttack; ///< 0=neither, 1=sneak attack, 2=death attack, 3=both
int iAttackType; ///< 65002=Attack of Opportunity, 65003=Riposte or a FeatID like KnockDown or some other special attack.
int bKillingBlow; ///< TRUE if the hit is a killing blow
int iToHitRoll; ///< The to hit roll of the attack
int iToHitModifier; ///< The to hit modifier of the attack
};
/// @struct NWNX_Damage_DamageData
@@ -66,13 +108,32 @@ struct NWNX_Damage_DamageData
int iNegative; ///< Negative damage
int iPositive; ///< Positive damage
int iSonic; ///< Sonic damage
int iCustom1; ///< Custom1 damage
int iCustom2; ///< Custom2 damage
int iCustom3; ///< Custom3 damage
int iCustom4; ///< Custom4 damage
int iCustom5; ///< Custom5 damage
int iCustom6; ///< Custom6 damage
int iCustom7; ///< Custom7 damage
int iCustom8; ///< Custom8 damage
int iCustom9; ///< Custom9 damage
int iCustom10; ///< Custom10 damage
int iCustom11; ///< Custom11 damage
int iCustom12; ///< Custom12 damage
int iCustom13; ///< Custom13 damage
int iCustom14; ///< Custom14 damage
int iCustom15; ///< Custom15 damage
int iCustom16; ///< Custom16 damage
int iCustom17; ///< Custom17 damage
int iCustom18; ///< Custom18 damage
int iCustom19; ///< Custom19 damage
int iPower; ///< For overcoming DR
};
/// @brief Sets the script to run with a damage event.
/// @param sScript The script that will handle the damage event.
/// @param oOwner An object if only executing for a specific object or OBJECT_INVALID for global.
void NWNX_Damage_SetDamageEventScript(string sScript, object oOwner=OBJECT_INVALID);
void NWNX_Damage_SetDamageEventScript(string sScript, object oOwner = OBJECT_INVALID);
/// @brief Get Damage Event Data
/// @return A NWNX_Damage_DamageEventData struct.
@@ -87,7 +148,7 @@ void NWNX_Damage_SetDamageEventData(struct NWNX_Damage_DamageEventData data);
/// @brief Sets the script to run with an attack event.
/// @param sScript The script that will handle the attack event.
/// @param oOwner An object if only executing for a specific object or OBJECT_INVALID for global.
void NWNX_Damage_SetAttackEventScript(string sScript, object oOwner=OBJECT_INVALID);
void NWNX_Damage_SetAttackEventScript(string sScript, object oOwner = OBJECT_INVALID);
/// @brief Get Attack Event Data
/// @return A NWNX_Damage_AttackEventData struct.
@@ -97,6 +158,7 @@ struct NWNX_Damage_AttackEventData NWNX_Damage_GetAttackEventData();
/// @brief Set Attack Event Data
/// @param data A NWNX_Damage_AttackEventData struct.
/// @note To use only in the Attack Event Script.
/// @note Setting iSneakAttack will only change the attack roll message and floating text feedback. Immunities and damage will have already been resolved by the time the attack event script is ran.
void NWNX_Damage_SetAttackEventData(struct NWNX_Damage_AttackEventData data);
/// @brief Deal damage to a target.
@@ -105,149 +167,229 @@ void NWNX_Damage_SetAttackEventData(struct NWNX_Damage_AttackEventData data);
/// @param oTarget The target object on whom the damage is dealt.
/// @param oSource The source of the damage.
/// @param iRanged Whether the attack should be treated as ranged by the engine (for example when considering damage inflicted by Acid Sheath and other such effects)
void NWNX_Damage_DealDamage(struct NWNX_Damage_DamageData data, object oTarget, object oSource=OBJECT_SELF, int iRanged = FALSE);
void NWNX_Damage_DealDamage(struct NWNX_Damage_DamageData data, object oTarget, object oSource = OBJECT_SELF, int iRanged = FALSE);
/// @}
void NWNX_Damage_SetDamageEventScript(string sScript, object oOwner=OBJECT_INVALID)
{
string sFunc = "SetEventScript";
NWNX_PushArgumentObject(NWNX_Damage, sFunc, oOwner);
NWNX_PushArgumentString(NWNX_Damage, sFunc, sScript);
NWNX_PushArgumentString(NWNX_Damage, sFunc, "DAMAGE");
NWNX_CallFunction(NWNX_Damage, sFunc);
NWNXPushObject(oOwner);
NWNXPushString(sScript);
NWNXPushString("DAMAGE");
NWNXCall(NWNX_Damage, "SetEventScript");
}
struct NWNX_Damage_DamageEventData NWNX_Damage_GetDamageEventData()
{
string sFunc = "GetDamageEventData";
struct NWNX_Damage_DamageEventData data;
NWNX_CallFunction(NWNX_Damage, sFunc);
data.oDamager = NWNX_GetReturnValueObject(NWNX_Damage, sFunc);
data.iBludgeoning = NWNX_GetReturnValueInt(NWNX_Damage, sFunc);
data.iPierce = NWNX_GetReturnValueInt(NWNX_Damage, sFunc);
data.iSlash = NWNX_GetReturnValueInt(NWNX_Damage, sFunc);
data.iMagical = NWNX_GetReturnValueInt(NWNX_Damage, sFunc);
data.iAcid = NWNX_GetReturnValueInt(NWNX_Damage, sFunc);
data.iCold = NWNX_GetReturnValueInt(NWNX_Damage, sFunc);
data.iDivine = NWNX_GetReturnValueInt(NWNX_Damage, sFunc);
data.iElectrical = NWNX_GetReturnValueInt(NWNX_Damage, sFunc);
data.iFire = NWNX_GetReturnValueInt(NWNX_Damage, sFunc);
data.iNegative = NWNX_GetReturnValueInt(NWNX_Damage, sFunc);
data.iPositive = NWNX_GetReturnValueInt(NWNX_Damage, sFunc);
data.iSonic = NWNX_GetReturnValueInt(NWNX_Damage, sFunc);
data.iBase = NWNX_GetReturnValueInt(NWNX_Damage, sFunc);
NWNXCall(NWNX_Damage, "GetDamageEventData");
data.oDamager = NWNXPopObject();
data.iBludgeoning = NWNXPopInt();
data.iPierce = NWNXPopInt();
data.iSlash = NWNXPopInt();
data.iMagical = NWNXPopInt();
data.iAcid = NWNXPopInt();
data.iCold = NWNXPopInt();
data.iDivine = NWNXPopInt();
data.iElectrical = NWNXPopInt();
data.iFire = NWNXPopInt();
data.iNegative = NWNXPopInt();
data.iPositive = NWNXPopInt();
data.iSonic = NWNXPopInt();
data.iBase = NWNXPopInt();
data.iCustom1 = NWNXPopInt();
data.iCustom2 = NWNXPopInt();
data.iCustom3 = NWNXPopInt();
data.iCustom4 = NWNXPopInt();
data.iCustom5 = NWNXPopInt();
data.iCustom6 = NWNXPopInt();
data.iCustom7 = NWNXPopInt();
data.iCustom8 = NWNXPopInt();
data.iCustom9 = NWNXPopInt();
data.iCustom10 = NWNXPopInt();
data.iCustom11 = NWNXPopInt();
data.iCustom12 = NWNXPopInt();
data.iCustom13 = NWNXPopInt();
data.iCustom14 = NWNXPopInt();
data.iCustom15 = NWNXPopInt();
data.iCustom16 = NWNXPopInt();
data.iCustom17 = NWNXPopInt();
data.iCustom18 = NWNXPopInt();
data.iCustom19 = NWNXPopInt();
data.iSpellId = NWNXPopInt();
return data;
}
void NWNX_Damage_SetDamageEventData(struct NWNX_Damage_DamageEventData data)
{
string sFunc = "SetDamageEventData";
NWNXPushInt(data.iCustom19);
NWNXPushInt(data.iCustom18);
NWNXPushInt(data.iCustom17);
NWNXPushInt(data.iCustom16);
NWNXPushInt(data.iCustom15);
NWNXPushInt(data.iCustom14);
NWNXPushInt(data.iCustom13);
NWNXPushInt(data.iCustom12);
NWNXPushInt(data.iCustom11);
NWNXPushInt(data.iCustom10);
NWNXPushInt(data.iCustom9);
NWNXPushInt(data.iCustom8);
NWNXPushInt(data.iCustom7);
NWNXPushInt(data.iCustom6);
NWNXPushInt(data.iCustom5);
NWNXPushInt(data.iCustom4);
NWNXPushInt(data.iCustom3);
NWNXPushInt(data.iCustom2);
NWNXPushInt(data.iCustom1);
NWNXPushInt(data.iBase);
NWNXPushInt(data.iSonic);
NWNXPushInt(data.iPositive);
NWNXPushInt(data.iNegative);
NWNXPushInt(data.iFire);
NWNXPushInt(data.iElectrical);
NWNXPushInt(data.iDivine);
NWNXPushInt(data.iCold);
NWNXPushInt(data.iAcid);
NWNXPushInt(data.iMagical);
NWNXPushInt(data.iSlash);
NWNXPushInt(data.iPierce);
NWNXPushInt(data.iBludgeoning);
NWNX_PushArgumentInt(NWNX_Damage, sFunc, data.iBase);
NWNX_PushArgumentInt(NWNX_Damage, sFunc, data.iSonic);
NWNX_PushArgumentInt(NWNX_Damage, sFunc, data.iPositive);
NWNX_PushArgumentInt(NWNX_Damage, sFunc, data.iNegative);
NWNX_PushArgumentInt(NWNX_Damage, sFunc, data.iFire);
NWNX_PushArgumentInt(NWNX_Damage, sFunc, data.iElectrical);
NWNX_PushArgumentInt(NWNX_Damage, sFunc, data.iDivine);
NWNX_PushArgumentInt(NWNX_Damage, sFunc, data.iCold);
NWNX_PushArgumentInt(NWNX_Damage, sFunc, data.iAcid);
NWNX_PushArgumentInt(NWNX_Damage, sFunc, data.iMagical);
NWNX_PushArgumentInt(NWNX_Damage, sFunc, data.iSlash);
NWNX_PushArgumentInt(NWNX_Damage, sFunc, data.iPierce);
NWNX_PushArgumentInt(NWNX_Damage, sFunc, data.iBludgeoning);
NWNX_CallFunction(NWNX_Damage, sFunc);
NWNXCall(NWNX_Damage, "SetDamageEventData");
}
void NWNX_Damage_SetAttackEventScript(string sScript, object oOwner=OBJECT_INVALID)
{
string sFunc = "SetEventScript";
NWNX_PushArgumentObject(NWNX_Damage, sFunc, oOwner);
NWNX_PushArgumentString(NWNX_Damage, sFunc, sScript);
NWNX_PushArgumentString(NWNX_Damage, sFunc, "ATTACK");
NWNX_CallFunction(NWNX_Damage, sFunc);
NWNXPushObject(oOwner);
NWNXPushString(sScript);
NWNXPushString("ATTACK");
NWNXCall(NWNX_Damage, "SetEventScript");
}
struct NWNX_Damage_AttackEventData NWNX_Damage_GetAttackEventData()
{
string sFunc = "GetAttackEventData";
struct NWNX_Damage_AttackEventData data;
NWNX_CallFunction(NWNX_Damage, sFunc);
data.oTarget = NWNX_GetReturnValueObject(NWNX_Damage, sFunc);
data.iBludgeoning = NWNX_GetReturnValueInt(NWNX_Damage, sFunc);
data.iPierce = NWNX_GetReturnValueInt(NWNX_Damage, sFunc);
data.iSlash = NWNX_GetReturnValueInt(NWNX_Damage, sFunc);
data.iMagical = NWNX_GetReturnValueInt(NWNX_Damage, sFunc);
data.iAcid = NWNX_GetReturnValueInt(NWNX_Damage, sFunc);
data.iCold = NWNX_GetReturnValueInt(NWNX_Damage, sFunc);
data.iDivine = NWNX_GetReturnValueInt(NWNX_Damage, sFunc);
data.iElectrical = NWNX_GetReturnValueInt(NWNX_Damage, sFunc);
data.iFire = NWNX_GetReturnValueInt(NWNX_Damage, sFunc);
data.iNegative = NWNX_GetReturnValueInt(NWNX_Damage, sFunc);
data.iPositive = NWNX_GetReturnValueInt(NWNX_Damage, sFunc);
data.iSonic = NWNX_GetReturnValueInt(NWNX_Damage, sFunc);
data.iBase = NWNX_GetReturnValueInt(NWNX_Damage, sFunc);
data.iAttackNumber = NWNX_GetReturnValueInt(NWNX_Damage, sFunc);
data.iAttackResult = NWNX_GetReturnValueInt(NWNX_Damage, sFunc);
data.iAttackType = NWNX_GetReturnValueInt(NWNX_Damage, sFunc);
data.iSneakAttack = NWNX_GetReturnValueInt(NWNX_Damage, sFunc);
NWNXCall(NWNX_Damage, "GetAttackEventData");
data.oTarget = NWNXPopObject();
data.iBludgeoning = NWNXPopInt();
data.iPierce = NWNXPopInt();
data.iSlash = NWNXPopInt();
data.iMagical = NWNXPopInt();
data.iAcid = NWNXPopInt();
data.iCold = NWNXPopInt();
data.iDivine = NWNXPopInt();
data.iElectrical = NWNXPopInt();
data.iFire = NWNXPopInt();
data.iNegative = NWNXPopInt();
data.iPositive = NWNXPopInt();
data.iSonic = NWNXPopInt();
data.iBase = NWNXPopInt();
data.iCustom1 = NWNXPopInt();
data.iCustom2 = NWNXPopInt();
data.iCustom3 = NWNXPopInt();
data.iCustom4 = NWNXPopInt();
data.iCustom5 = NWNXPopInt();
data.iCustom6 = NWNXPopInt();
data.iCustom7 = NWNXPopInt();
data.iCustom8 = NWNXPopInt();
data.iCustom9 = NWNXPopInt();
data.iCustom10 = NWNXPopInt();
data.iCustom11 = NWNXPopInt();
data.iCustom12 = NWNXPopInt();
data.iCustom13 = NWNXPopInt();
data.iCustom14 = NWNXPopInt();
data.iCustom15 = NWNXPopInt();
data.iCustom16 = NWNXPopInt();
data.iCustom17 = NWNXPopInt();
data.iCustom18 = NWNXPopInt();
data.iCustom19 = NWNXPopInt();
data.iAttackNumber = NWNXPopInt();
data.iAttackResult = NWNXPopInt();
data.iWeaponAttackType = NWNXPopInt();
data.iSneakAttack = NWNXPopInt();
data.bKillingBlow = NWNXPopInt();
data.iAttackType = NWNXPopInt();
data.iToHitRoll = NWNXPopInt();
data.iToHitModifier = NWNXPopInt();
return data;
}
void NWNX_Damage_SetAttackEventData(struct NWNX_Damage_AttackEventData data)
{
string sFunc = "SetAttackEventData";
NWNX_PushArgumentInt(NWNX_Damage, sFunc, data.iAttackResult);
NWNX_PushArgumentInt(NWNX_Damage, sFunc, data.iBase);
NWNX_PushArgumentInt(NWNX_Damage, sFunc, data.iSonic);
NWNX_PushArgumentInt(NWNX_Damage, sFunc, data.iPositive);
NWNX_PushArgumentInt(NWNX_Damage, sFunc, data.iNegative);
NWNX_PushArgumentInt(NWNX_Damage, sFunc, data.iFire);
NWNX_PushArgumentInt(NWNX_Damage, sFunc, data.iElectrical);
NWNX_PushArgumentInt(NWNX_Damage, sFunc, data.iDivine);
NWNX_PushArgumentInt(NWNX_Damage, sFunc, data.iCold);
NWNX_PushArgumentInt(NWNX_Damage, sFunc, data.iAcid);
NWNX_PushArgumentInt(NWNX_Damage, sFunc, data.iMagical);
NWNX_PushArgumentInt(NWNX_Damage, sFunc, data.iSlash);
NWNX_PushArgumentInt(NWNX_Damage, sFunc, data.iPierce);
NWNX_PushArgumentInt(NWNX_Damage, sFunc, data.iBludgeoning);
NWNX_CallFunction(NWNX_Damage, sFunc);
NWNXPushInt(data.iSneakAttack);
NWNXPushInt(data.iAttackResult);
NWNXPushInt(data.iCustom19);
NWNXPushInt(data.iCustom18);
NWNXPushInt(data.iCustom17);
NWNXPushInt(data.iCustom16);
NWNXPushInt(data.iCustom15);
NWNXPushInt(data.iCustom14);
NWNXPushInt(data.iCustom13);
NWNXPushInt(data.iCustom12);
NWNXPushInt(data.iCustom11);
NWNXPushInt(data.iCustom10);
NWNXPushInt(data.iCustom9);
NWNXPushInt(data.iCustom8);
NWNXPushInt(data.iCustom7);
NWNXPushInt(data.iCustom6);
NWNXPushInt(data.iCustom5);
NWNXPushInt(data.iCustom4);
NWNXPushInt(data.iCustom3);
NWNXPushInt(data.iCustom2);
NWNXPushInt(data.iCustom1);
NWNXPushInt(data.iBase);
NWNXPushInt(data.iSonic);
NWNXPushInt(data.iPositive);
NWNXPushInt(data.iNegative);
NWNXPushInt(data.iFire);
NWNXPushInt(data.iElectrical);
NWNXPushInt(data.iDivine);
NWNXPushInt(data.iCold);
NWNXPushInt(data.iAcid);
NWNXPushInt(data.iMagical);
NWNXPushInt(data.iSlash);
NWNXPushInt(data.iPierce);
NWNXPushInt(data.iBludgeoning);
NWNXCall(NWNX_Damage, "SetAttackEventData");
}
void NWNX_Damage_DealDamage(struct NWNX_Damage_DamageData data, object oTarget, object oSource, int iRanged = FALSE)
{
string sFunc = "DealDamage";
NWNX_PushArgumentInt(NWNX_Damage, sFunc, iRanged);
NWNX_PushArgumentInt(NWNX_Damage, sFunc, data.iPower);
NWNX_PushArgumentInt(NWNX_Damage, sFunc, data.iSonic);
NWNX_PushArgumentInt(NWNX_Damage, sFunc, data.iPositive);
NWNX_PushArgumentInt(NWNX_Damage, sFunc, data.iNegative);
NWNX_PushArgumentInt(NWNX_Damage, sFunc, data.iFire);
NWNX_PushArgumentInt(NWNX_Damage, sFunc, data.iElectrical);
NWNX_PushArgumentInt(NWNX_Damage, sFunc, data.iDivine);
NWNX_PushArgumentInt(NWNX_Damage, sFunc, data.iCold);
NWNX_PushArgumentInt(NWNX_Damage, sFunc, data.iAcid);
NWNX_PushArgumentInt(NWNX_Damage, sFunc, data.iMagical);
NWNX_PushArgumentInt(NWNX_Damage, sFunc, data.iSlash);
NWNX_PushArgumentInt(NWNX_Damage, sFunc, data.iPierce);
NWNX_PushArgumentInt(NWNX_Damage, sFunc, data.iBludgeoning);
NWNX_PushArgumentObject(NWNX_Damage, sFunc, oTarget);
NWNX_PushArgumentObject(NWNX_Damage, sFunc, oSource);
NWNX_CallFunction(NWNX_Damage, sFunc);
NWNXPushInt(iRanged);
NWNXPushInt(data.iPower);
NWNXPushInt(data.iCustom19);
NWNXPushInt(data.iCustom18);
NWNXPushInt(data.iCustom17);
NWNXPushInt(data.iCustom16);
NWNXPushInt(data.iCustom15);
NWNXPushInt(data.iCustom14);
NWNXPushInt(data.iCustom13);
NWNXPushInt(data.iCustom12);
NWNXPushInt(data.iCustom11);
NWNXPushInt(data.iCustom10);
NWNXPushInt(data.iCustom9);
NWNXPushInt(data.iCustom8);
NWNXPushInt(data.iCustom7);
NWNXPushInt(data.iCustom6);
NWNXPushInt(data.iCustom5);
NWNXPushInt(data.iCustom4);
NWNXPushInt(data.iCustom3);
NWNXPushInt(data.iCustom2);
NWNXPushInt(data.iCustom1);
NWNXPushInt(0);// Padding for Base Damage
NWNXPushInt(data.iSonic);
NWNXPushInt(data.iPositive);
NWNXPushInt(data.iNegative);
NWNXPushInt(data.iFire);
NWNXPushInt(data.iElectrical);
NWNXPushInt(data.iDivine);
NWNXPushInt(data.iCold);
NWNXPushInt(data.iAcid);
NWNXPushInt(data.iMagical);
NWNXPushInt(data.iSlash);
NWNXPushInt(data.iPierce);
NWNXPushInt(data.iBludgeoning);
NWNXPushObject(oTarget);
NWNXPushObject(oSource);
NWNXCall(NWNX_Damage, "DealDamage");
}

View File

@@ -2,15 +2,17 @@
/// @brief Provides a number of data structures for NWN code to use (simulated arrays)
/// @{
/// @file nwnx_data.nss
#include "nwnx"
const string NWNX_Data = "NWNX_Data"; ///< @private
#include "inc_array"
const int NWNX_DATA_INVALID_INDEX = -1;
const int NWNX_DATA_TYPE_FLOAT = 0;
const int NWNX_DATA_TYPE_INTEGER = 1;
const int NWNX_DATA_TYPE_OBJECT = 2;
const int NWNX_DATA_TYPE_STRING = 3;
// All these calls just pass through to the Array code in inc_array to provide
// an NWNX_Data compatible API for ease of transition.
const int NWNX_DATA_INVALID_INDEX = INVALID_INDEX;
const int NWNX_DATA_TYPE_FLOAT = TYPE_FLOAT;
const int NWNX_DATA_TYPE_INTEGER = TYPE_INTEGER;
const int NWNX_DATA_TYPE_OBJECT = TYPE_OBJECT;
const int NWNX_DATA_TYPE_STRING = TYPE_STRING;
/// @defgroup data_array_at Array At
/// @brief Returns the element at the index.
@@ -20,10 +22,10 @@ const int NWNX_DATA_TYPE_STRING = 3;
/// @param index The index.
/// @return The element of associated type.
/// @{
float NWNX_Data_Array_At_Flt(object obj, string tag, int index);
int NWNX_Data_Array_At_Int(object obj, string tag, int index);
object NWNX_Data_Array_At_Obj(object obj, string tag, int index);
string NWNX_Data_Array_At_Str(object obj, string tag, int index);
float NWNX_Data_Array_At_Flt(object obj, string tag, int index);
int NWNX_Data_Array_At_Int(object obj, string tag, int index);
object NWNX_Data_Array_At_Obj(object obj, string tag, int index);
/// @}
@@ -38,8 +40,8 @@ void NWNX_Data_Array_Clear(int type, object obj, string tag);
/// @param element The element.
/// @return TRUE if the collection contains the element.
/// @{
int NWNX_Data_Array_Contains_Flt(object obj, string tag, float element);
int NWNX_Data_Array_Contains_Int(object obj, string tag, int element);
int NWNX_Data_Array_Contains_Flt(object obj, string tag, float element);
int NWNX_Data_Array_Contains_Int(object obj, string tag, int element);
int NWNX_Data_Array_Contains_Obj(object obj, string tag, object element);
int NWNX_Data_Array_Contains_Str(object obj, string tag, string element);
/// @}
@@ -58,8 +60,8 @@ void NWNX_Data_Array_Erase(int type, object obj, string tag, int index);
/// @param element The element.
/// @return Returns the index at which the element is located, or ARRAY_INVALID_INDEX.
/// @{
int NWNX_Data_Array_Find_Flt(object obj, string tag, float element);
int NWNX_Data_Array_Find_Int(object obj, string tag, int element);
int NWNX_Data_Array_Find_Flt(object obj, string tag, float element);
int NWNX_Data_Array_Find_Int(object obj, string tag, int element);
int NWNX_Data_Array_Find_Obj(object obj, string tag, object element);
int NWNX_Data_Array_Find_Str(object obj, string tag, string element);
/// @}
@@ -72,8 +74,8 @@ int NWNX_Data_Array_Find_Str(object obj, string tag, string element);
/// @param index The index.
/// @param element The element.
/// @{
void NWNX_Data_Array_Insert_Flt(object obj, string tag, int index, float element);
void NWNX_Data_Array_Insert_Int(object obj, string tag, int index, int element);
void NWNX_Data_Array_Insert_Flt(object obj, string tag, int index, float element);
void NWNX_Data_Array_Insert_Int(object obj, string tag, int index, int element);
void NWNX_Data_Array_Insert_Obj(object obj, string tag, int index, object element);
void NWNX_Data_Array_Insert_Str(object obj, string tag, int index, string element);
/// @}
@@ -86,8 +88,8 @@ void NWNX_Data_Array_Insert_Str(object obj, string tag, int index, string elemen
/// @param tag The tag.
/// @param element The element.
/// @{
void NWNX_Data_Array_PushBack_Flt(object obj, string tag, float element);
void NWNX_Data_Array_PushBack_Int(object obj, string tag, int element);
void NWNX_Data_Array_PushBack_Flt(object obj, string tag, float element);
void NWNX_Data_Array_PushBack_Int(object obj, string tag, int element);
void NWNX_Data_Array_PushBack_Obj(object obj, string tag, object element);
void NWNX_Data_Array_PushBack_Str(object obj, string tag, string element);
/// @}
@@ -115,346 +117,235 @@ void NWNX_Data_Array_SortDescending(int type, object obj, string tag);
/// @param index The index.
/// @param element The element.
/// @{
void NWNX_Data_Array_Set_Flt(object obj, string tag, int index, float element);
void NWNX_Data_Array_Set_Int(object obj, string tag, int index, int element);
void NWNX_Data_Array_Set_Flt(object obj, string tag, int index, float element);
void NWNX_Data_Array_Set_Int(object obj, string tag, int index, int element);
void NWNX_Data_Array_Set_Obj(object obj, string tag, int index, object element);
void NWNX_Data_Array_Set_Str(object obj, string tag, int index, string element);
/// @}
/// @}
////////////////////////////////////////////////////////////////////////////////
// return the value contained in location "index"
string NWNX_Data_Array_At_Str(object obj, string tag, int index)
{
WriteTimestampedLogEntry("WARNING: NWNX_Data is deprecated. You should migrate to Array (see inc_array)");
return Array_At_Str(tag, index, obj);
}
float NWNX_Data_Array_At_Flt(object obj, string tag, int index)
{
string sFunc = "ArrayAt";
NWNX_PushArgumentInt(NWNX_Data, sFunc, index);
NWNX_PushArgumentString(NWNX_Data, sFunc, tag);
NWNX_PushArgumentObject(NWNX_Data, sFunc, obj);
NWNX_PushArgumentInt(NWNX_Data, sFunc, NWNX_DATA_TYPE_FLOAT);
NWNX_CallFunction(NWNX_Data, sFunc);
return NWNX_GetReturnValueFloat(NWNX_Data, sFunc);
WriteTimestampedLogEntry("WARNING: NWNX_Data is deprecated. You should migrate to Array (see inc_array)");
return Array_At_Flt(tag, index, obj);
}
int NWNX_Data_Array_At_Int(object obj, string tag, int index)
{
string sFunc = "ArrayAt";
NWNX_PushArgumentInt(NWNX_Data, sFunc, index);
NWNX_PushArgumentString(NWNX_Data, sFunc, tag);
NWNX_PushArgumentObject(NWNX_Data, sFunc, obj);
NWNX_PushArgumentInt(NWNX_Data, sFunc, NWNX_DATA_TYPE_INTEGER);
NWNX_CallFunction(NWNX_Data, sFunc);
return NWNX_GetReturnValueInt(NWNX_Data, sFunc);
WriteTimestampedLogEntry("WARNING: NWNX_Data is deprecated. You should migrate to Array (see inc_array)");
return Array_At_Int(tag, index, obj);
}
object NWNX_Data_Array_At_Obj(object obj, string tag, int index)
{
string sFunc = "ArrayAt";
NWNX_PushArgumentInt(NWNX_Data, sFunc, index);
NWNX_PushArgumentString(NWNX_Data, sFunc, tag);
NWNX_PushArgumentObject(NWNX_Data, sFunc, obj);
NWNX_PushArgumentInt(NWNX_Data, sFunc, NWNX_DATA_TYPE_OBJECT);
NWNX_CallFunction(NWNX_Data, sFunc);
return NWNX_GetReturnValueObject(NWNX_Data, sFunc);
}
string NWNX_Data_Array_At_Str(object obj, string tag, int index)
{
string sFunc = "ArrayAt";
NWNX_PushArgumentInt(NWNX_Data, sFunc, index);
NWNX_PushArgumentString(NWNX_Data, sFunc, tag);
NWNX_PushArgumentObject(NWNX_Data, sFunc, obj);
NWNX_PushArgumentInt(NWNX_Data, sFunc, NWNX_DATA_TYPE_STRING);
NWNX_CallFunction(NWNX_Data, sFunc);
return NWNX_GetReturnValueString(NWNX_Data, sFunc);
WriteTimestampedLogEntry("WARNING: NWNX_Data is deprecated. You should migrate to Array (see inc_array)");
return Array_At_Obj(tag, index, obj);
}
void NWNX_Data_Array_Clear(int type, object obj, string tag)
{
string sFunc = "ArrayClear";
NWNX_PushArgumentString(NWNX_Data, sFunc, tag);
NWNX_PushArgumentObject(NWNX_Data, sFunc, obj);
NWNX_PushArgumentInt(NWNX_Data, sFunc, type);
NWNX_CallFunction(NWNX_Data, sFunc);
WriteTimestampedLogEntry("WARNING: NWNX_Data is deprecated. You should migrate to Array (see inc_array)");
Array_Clear(tag, obj);
}
////////////////////////////////////////////////////////////////////////////////
// Return true/value (1/0) if the array contains the value "element"
int NWNX_Data_Array_Contains_Str(object obj, string tag, string element)
{
WriteTimestampedLogEntry("WARNING: NWNX_Data is deprecated. You should migrate to Array (see inc_array)");
return Array_Contains_Str(tag, element, obj);
}
int NWNX_Data_Array_Contains_Flt(object obj, string tag, float element)
{
string sFunc = "ArrayContains";
NWNX_PushArgumentFloat(NWNX_Data, sFunc, element);
NWNX_PushArgumentString(NWNX_Data, sFunc, tag);
NWNX_PushArgumentObject(NWNX_Data, sFunc, obj);
NWNX_PushArgumentInt(NWNX_Data, sFunc, NWNX_DATA_TYPE_FLOAT);
NWNX_CallFunction(NWNX_Data, sFunc);
return NWNX_GetReturnValueInt(NWNX_Data, sFunc);
WriteTimestampedLogEntry("WARNING: NWNX_Data is deprecated. You should migrate to Array (see inc_array)");
return Array_Contains_Flt(tag, element, obj);
}
int NWNX_Data_Array_Contains_Int(object obj, string tag, int element)
{
string sFunc = "ArrayContains";
NWNX_PushArgumentInt(NWNX_Data, sFunc, element);
NWNX_PushArgumentString(NWNX_Data, sFunc, tag);
NWNX_PushArgumentObject(NWNX_Data, sFunc, obj);
NWNX_PushArgumentInt(NWNX_Data, sFunc, NWNX_DATA_TYPE_INTEGER);
NWNX_CallFunction(NWNX_Data, sFunc);
return NWNX_GetReturnValueInt(NWNX_Data, sFunc);
WriteTimestampedLogEntry("WARNING: NWNX_Data is deprecated. You should migrate to Array (see inc_array)");
return Array_Contains_Int(tag, element, obj);
}
int NWNX_Data_Array_Contains_Obj(object obj, string tag, object element)
{
string sFunc = "ArrayContains";
NWNX_PushArgumentObject(NWNX_Data, sFunc, element);
NWNX_PushArgumentString(NWNX_Data, sFunc, tag);
NWNX_PushArgumentObject(NWNX_Data, sFunc, obj);
NWNX_PushArgumentInt(NWNX_Data, sFunc, NWNX_DATA_TYPE_OBJECT);
NWNX_CallFunction(NWNX_Data, sFunc);
return NWNX_GetReturnValueInt(NWNX_Data, sFunc);
WriteTimestampedLogEntry("WARNING: NWNX_Data is deprecated. You should migrate to Array (see inc_array)");
return Array_Contains_Obj(tag, element, obj);
}
int NWNX_Data_Array_Contains_Str(object obj, string tag, string element)
{
string sFunc = "ArrayContains";
NWNX_PushArgumentString(NWNX_Data, sFunc, element);
NWNX_PushArgumentString(NWNX_Data, sFunc, tag);
NWNX_PushArgumentObject(NWNX_Data, sFunc, obj);
NWNX_PushArgumentInt(NWNX_Data, sFunc, NWNX_DATA_TYPE_STRING);
NWNX_CallFunction(NWNX_Data, sFunc);
return NWNX_GetReturnValueInt(NWNX_Data, sFunc);
}
////////////////////////////////////////////////////////////////////////////////
void NWNX_Data_Array_Copy(int type, object obj, string tag, string otherTag)
{
string sFunc = "ArrayCopy";
NWNX_PushArgumentString(NWNX_Data, sFunc, otherTag);
NWNX_PushArgumentString(NWNX_Data, sFunc, tag);
NWNX_PushArgumentObject(NWNX_Data, sFunc, obj);
NWNX_PushArgumentInt(NWNX_Data, sFunc, type);
NWNX_CallFunction(NWNX_Data, sFunc);
WriteTimestampedLogEntry("WARNING: NWNX_Data is deprecated. You should migrate to Array (see inc_array)");
Array_Copy(tag, otherTag, obj);
}
////////////////////////////////////////////////////////////////////////////////
void NWNX_Data_Array_Erase(int type, object obj, string tag, int index)
{
string sFunc = "ArrayErase";
NWNX_PushArgumentInt(NWNX_Data, sFunc, index);
NWNX_PushArgumentString(NWNX_Data, sFunc, tag);
NWNX_PushArgumentObject(NWNX_Data, sFunc, obj);
NWNX_PushArgumentInt(NWNX_Data, sFunc, type);
NWNX_CallFunction(NWNX_Data, sFunc);
WriteTimestampedLogEntry("WARNING: NWNX_Data is deprecated. You should migrate to Array (see inc_array)");
Array_Erase(tag, index, obj);
}
////////////////////////////////////////////////////////////////////////////////
// return the index in the array containing "element"
// if not found, return NWNX_DATA_INVALID_INDEX
int NWNX_Data_Array_Find_Str(object obj, string tag, string element)
{
WriteTimestampedLogEntry("WARNING: NWNX_Data is deprecated. You should migrate to Array (see inc_array)");
return Array_Find_Str(tag, element, obj);
}
int NWNX_Data_Array_Find_Flt(object obj, string tag, float element)
{
string sFunc = "ArrayFind";
NWNX_PushArgumentFloat(NWNX_Data, sFunc, element);
NWNX_PushArgumentString(NWNX_Data, sFunc, tag);
NWNX_PushArgumentObject(NWNX_Data, sFunc, obj);
NWNX_PushArgumentInt(NWNX_Data, sFunc, NWNX_DATA_TYPE_FLOAT);
NWNX_CallFunction(NWNX_Data, sFunc);
return NWNX_GetReturnValueInt(NWNX_Data, sFunc);
WriteTimestampedLogEntry("WARNING: NWNX_Data is deprecated. You should migrate to Array (see inc_array)");
return Array_Find_Flt(tag, element, obj);
}
int NWNX_Data_Array_Find_Int(object obj, string tag, int element)
{
string sFunc = "ArrayFind";
NWNX_PushArgumentInt(NWNX_Data, sFunc, element);
NWNX_PushArgumentString(NWNX_Data, sFunc, tag);
NWNX_PushArgumentObject(NWNX_Data, sFunc, obj);
NWNX_PushArgumentInt(NWNX_Data, sFunc, NWNX_DATA_TYPE_INTEGER);
NWNX_CallFunction(NWNX_Data, sFunc);
return NWNX_GetReturnValueInt(NWNX_Data, sFunc);
WriteTimestampedLogEntry("WARNING: NWNX_Data is deprecated. You should migrate to Array (see inc_array)");
return Array_Find_Int(tag, element, obj);
}
int NWNX_Data_Array_Find_Obj(object obj, string tag, object element)
{
string sFunc = "ArrayFind";
NWNX_PushArgumentObject(NWNX_Data, sFunc, element);
NWNX_PushArgumentString(NWNX_Data, sFunc, tag);
NWNX_PushArgumentObject(NWNX_Data, sFunc, obj);
NWNX_PushArgumentInt(NWNX_Data, sFunc, NWNX_DATA_TYPE_OBJECT);
NWNX_CallFunction(NWNX_Data, sFunc);
return NWNX_GetReturnValueInt(NWNX_Data, sFunc);
WriteTimestampedLogEntry("WARNING: NWNX_Data is deprecated. You should migrate to Array (see inc_array)");
return Array_Find_Obj(tag, element, obj);
}
int NWNX_Data_Array_Find_Str(object obj, string tag, string element)
////////////////////////////////////////////////////////////////////////////////
// Insert a new element into position 'index'. If index is beyond the number of rows in the array,
// this will quietly fail. This could be changed if you wanted to support sparse
// arrays.
void NWNX_Data_Array_Insert_Str(object obj, string tag, int index, string element)
{
string sFunc = "ArrayFind";
NWNX_PushArgumentString(NWNX_Data, sFunc, element);
NWNX_PushArgumentString(NWNX_Data, sFunc, tag);
NWNX_PushArgumentObject(NWNX_Data, sFunc, obj);
NWNX_PushArgumentInt(NWNX_Data, sFunc, NWNX_DATA_TYPE_STRING);
NWNX_CallFunction(NWNX_Data, sFunc);
return NWNX_GetReturnValueInt(NWNX_Data, sFunc);
WriteTimestampedLogEntry("WARNING: NWNX_Data is deprecated. You should migrate to Array (see inc_array)");
Array_Insert_Str(tag, index, element, obj);
}
void NWNX_Data_Array_Insert_Flt(object obj, string tag, int index, float element)
{
string sFunc = "ArrayInsert";
NWNX_PushArgumentFloat(NWNX_Data, sFunc, element);
NWNX_PushArgumentInt(NWNX_Data, sFunc, index);
NWNX_PushArgumentString(NWNX_Data, sFunc, tag);
NWNX_PushArgumentObject(NWNX_Data, sFunc, obj);
NWNX_PushArgumentInt(NWNX_Data, sFunc, NWNX_DATA_TYPE_FLOAT);
NWNX_CallFunction(NWNX_Data, sFunc);
WriteTimestampedLogEntry("WARNING: NWNX_Data is deprecated. You should migrate to Array (see inc_array)");
Array_Insert_Flt(tag, index, element, obj);
}
void NWNX_Data_Array_Insert_Int(object obj, string tag, int index, int element)
{
string sFunc = "ArrayInsert";
NWNX_PushArgumentInt(NWNX_Data, sFunc, element);
NWNX_PushArgumentInt(NWNX_Data, sFunc, index);
NWNX_PushArgumentString(NWNX_Data, sFunc, tag);
NWNX_PushArgumentObject(NWNX_Data, sFunc, obj);
NWNX_PushArgumentInt(NWNX_Data, sFunc, NWNX_DATA_TYPE_INTEGER);
NWNX_CallFunction(NWNX_Data, sFunc);
WriteTimestampedLogEntry("WARNING: NWNX_Data is deprecated. You should migrate to Array (see inc_array)");
Array_Insert_Int(tag, index, element, obj);
}
void NWNX_Data_Array_Insert_Obj(object obj, string tag, int index, object element)
{
string sFunc = "ArrayInsert";
NWNX_PushArgumentObject(NWNX_Data, sFunc, element);
NWNX_PushArgumentInt(NWNX_Data, sFunc, index);
NWNX_PushArgumentString(NWNX_Data, sFunc, tag);
NWNX_PushArgumentObject(NWNX_Data, sFunc, obj);
NWNX_PushArgumentInt(NWNX_Data, sFunc, NWNX_DATA_TYPE_OBJECT);
NWNX_CallFunction(NWNX_Data, sFunc);
WriteTimestampedLogEntry("WARNING: NWNX_Data is deprecated. You should migrate to Array (see inc_array)");
Array_Insert_Obj(tag, index, element, obj);
}
void NWNX_Data_Array_Insert_Str(object obj, string tag, int index, string element)
////////////////////////////////////////////////////////////////////////////////
// Insert a new element at the end of the array.
void NWNX_Data_Array_PushBack_Str(object obj, string tag, string element)
{
string sFunc = "ArrayInsert";
NWNX_PushArgumentString(NWNX_Data, sFunc, element);
NWNX_PushArgumentInt(NWNX_Data, sFunc, index);
NWNX_PushArgumentString(NWNX_Data, sFunc, tag);
NWNX_PushArgumentObject(NWNX_Data, sFunc, obj);
NWNX_PushArgumentInt(NWNX_Data, sFunc, NWNX_DATA_TYPE_STRING);
NWNX_CallFunction(NWNX_Data, sFunc);
WriteTimestampedLogEntry("WARNING: NWNX_Data is deprecated. You should migrate to Array (see inc_array)");
Array_PushBack_Str(tag, element, obj);
}
void NWNX_Data_Array_PushBack_Flt(object obj, string tag, float element)
{
string sFunc = "ArrayPushBack";
NWNX_PushArgumentFloat(NWNX_Data, sFunc, element);
NWNX_PushArgumentString(NWNX_Data, sFunc, tag);
NWNX_PushArgumentObject(NWNX_Data, sFunc, obj);
NWNX_PushArgumentInt(NWNX_Data, sFunc, NWNX_DATA_TYPE_FLOAT);
NWNX_CallFunction(NWNX_Data, sFunc);
WriteTimestampedLogEntry("WARNING: NWNX_Data is deprecated. You should migrate to Array (see inc_array)");
Array_PushBack_Flt(tag, element, obj);
}
void NWNX_Data_Array_PushBack_Int(object obj, string tag, int element)
{
string sFunc = "ArrayPushBack";
NWNX_PushArgumentInt(NWNX_Data, sFunc, element);
NWNX_PushArgumentString(NWNX_Data, sFunc, tag);
NWNX_PushArgumentObject(NWNX_Data, sFunc, obj);
NWNX_PushArgumentInt(NWNX_Data, sFunc, NWNX_DATA_TYPE_INTEGER);
NWNX_CallFunction(NWNX_Data, sFunc);
WriteTimestampedLogEntry("WARNING: NWNX_Data is deprecated. You should migrate to Array (see inc_array)");
Array_PushBack_Int(tag, element, obj);
}
void NWNX_Data_Array_PushBack_Obj(object obj, string tag, object element)
{
string sFunc = "ArrayPushBack";
NWNX_PushArgumentObject(NWNX_Data, sFunc, element);
NWNX_PushArgumentString(NWNX_Data, sFunc, tag);
NWNX_PushArgumentObject(NWNX_Data, sFunc, obj);
NWNX_PushArgumentInt(NWNX_Data, sFunc, NWNX_DATA_TYPE_OBJECT);
NWNX_CallFunction(NWNX_Data, sFunc);
}
void NWNX_Data_Array_PushBack_Str(object obj, string tag, string element)
{
string sFunc = "ArrayPushBack";
NWNX_PushArgumentString(NWNX_Data, sFunc, element);
NWNX_PushArgumentString(NWNX_Data, sFunc, tag);
NWNX_PushArgumentObject(NWNX_Data, sFunc, obj);
NWNX_PushArgumentInt(NWNX_Data, sFunc, NWNX_DATA_TYPE_STRING);
NWNX_CallFunction(NWNX_Data, sFunc);
WriteTimestampedLogEntry("WARNING: NWNX_Data is deprecated. You should migrate to Array (see inc_array)");
Array_PushBack_Obj(tag, element, obj);
}
////////////////////////////////////////////////////////////////////////////////
// Cuts the array off at size 'size'. Elements beyond size are removed.
void NWNX_Data_Array_Resize(int type, object obj, string tag, int size)
{
string sFunc = "ArrayResize";
NWNX_PushArgumentInt(NWNX_Data, sFunc, size);
NWNX_PushArgumentString(NWNX_Data, sFunc, tag);
NWNX_PushArgumentObject(NWNX_Data, sFunc, obj);
NWNX_PushArgumentInt(NWNX_Data, sFunc, type);
NWNX_CallFunction(NWNX_Data, sFunc);
WriteTimestampedLogEntry("WARNING: NWNX_Data is deprecated. You should migrate to Array (see inc_array)");
Array_Resize(tag, size, obj);
}
////////////////////////////////////////////////////////////////////////////////
void NWNX_Data_Array_Shuffle(int type, object obj, string tag)
{
string sFunc = "ArrayShuffle";
NWNX_PushArgumentString(NWNX_Data, sFunc, tag);
NWNX_PushArgumentObject(NWNX_Data, sFunc, obj);
NWNX_PushArgumentInt(NWNX_Data, sFunc, type);
NWNX_CallFunction(NWNX_Data, sFunc);
WriteTimestampedLogEntry("WARNING: NWNX_Data is deprecated. You should migrate to Array (see inc_array)");
Array_Shuffle(tag, obj);
}
////////////////////////////////////////////////////////////////////////////////
int NWNX_Data_Array_Size(int type, object obj, string tag)
{
string sFunc = "ArraySize";
NWNX_PushArgumentString(NWNX_Data, sFunc, tag);
NWNX_PushArgumentObject(NWNX_Data, sFunc, obj);
NWNX_PushArgumentInt(NWNX_Data, sFunc, type);
NWNX_CallFunction(NWNX_Data, sFunc);
return NWNX_GetReturnValueInt(NWNX_Data, sFunc);
WriteTimestampedLogEntry("WARNING: NWNX_Data is deprecated. You should migrate to Array (see inc_array)");
return Array_Size(tag, obj);
}
////////////////////////////////////////////////////////////////////////////////
// Sort the array by value according to 'direciton' (ASC or DESC)
// Note that this is a lexical sort, so sorting an array of ints or floats will have
// odd results
void NWNX_Data_Array_Sort(object obj, string tag, string direction)
{
WriteTimestampedLogEntry("WARNING: NWNX_Data is deprecated. You should migrate to Array (see inc_array)");
Array_Sort(tag, direction, TYPE_STRING, obj);
}
void NWNX_Data_Array_SortAscending(int type, object obj, string tag)
{
string sFunc = "ArraySortAscending";
NWNX_PushArgumentString(NWNX_Data, sFunc, tag);
NWNX_PushArgumentObject(NWNX_Data, sFunc, obj);
NWNX_PushArgumentInt(NWNX_Data, sFunc, type);
NWNX_CallFunction(NWNX_Data, sFunc);
WriteTimestampedLogEntry("WARNING: NWNX_Data is deprecated. You should migrate to Array (see inc_array)");
Array_SortAscending(tag, TYPE_STRING, obj);
}
void NWNX_Data_Array_SortDescending(int type, object obj, string tag)
{
string sFunc = "ArraySortDescending";
NWNX_PushArgumentString(NWNX_Data, sFunc, tag);
NWNX_PushArgumentObject(NWNX_Data, sFunc, obj);
NWNX_PushArgumentInt(NWNX_Data, sFunc, type);
NWNX_CallFunction(NWNX_Data, sFunc);
WriteTimestampedLogEntry("WARNING: NWNX_Data is deprecated. You should migrate to Array (see inc_array)");
Array_SortDescending(tag, TYPE_STRING, obj);
}
////////////////////////////////////////////////////////////////////////////////
// Set the value of array index 'index' to a 'element'
// This will quietly eat values if index > array size
void NWNX_Data_Array_Set_Str(object obj, string tag, int index, string element)
{
WriteTimestampedLogEntry("WARNING: NWNX_Data is deprecated. You should migrate to Array (see inc_array)");
Array_Set_Str(tag, index, element, obj);
}
void NWNX_Data_Array_Set_Flt(object obj, string tag, int index, float element)
{
string sFunc = "ArraySet";
NWNX_PushArgumentFloat(NWNX_Data, sFunc, element);
NWNX_PushArgumentInt(NWNX_Data, sFunc, index);
NWNX_PushArgumentString(NWNX_Data, sFunc, tag);
NWNX_PushArgumentObject(NWNX_Data, sFunc, obj);
NWNX_PushArgumentInt(NWNX_Data, sFunc, NWNX_DATA_TYPE_FLOAT);
NWNX_CallFunction(NWNX_Data, sFunc);
WriteTimestampedLogEntry("WARNING: NWNX_Data is deprecated. You should migrate to Array (see inc_array)");
Array_Set_Flt(tag, index, element, obj);
}
void NWNX_Data_Array_Set_Int(object obj, string tag, int index, int element)
{
string sFunc = "ArraySet";
NWNX_PushArgumentInt(NWNX_Data, sFunc, element);
NWNX_PushArgumentInt(NWNX_Data, sFunc, index);
NWNX_PushArgumentString(NWNX_Data, sFunc, tag);
NWNX_PushArgumentObject(NWNX_Data, sFunc, obj);
NWNX_PushArgumentInt(NWNX_Data, sFunc, NWNX_DATA_TYPE_INTEGER);
NWNX_CallFunction(NWNX_Data, sFunc);
WriteTimestampedLogEntry("WARNING: NWNX_Data is deprecated. You should migrate to Array (see inc_array)");
Array_Set_Int(tag, index, element, obj);
}
void NWNX_Data_Array_Set_Obj(object obj, string tag, int index, object element)
{
string sFunc = "ArraySet";
NWNX_PushArgumentObject(NWNX_Data, sFunc, element);
NWNX_PushArgumentInt(NWNX_Data, sFunc, index);
NWNX_PushArgumentString(NWNX_Data, sFunc, tag);
NWNX_PushArgumentObject(NWNX_Data,sFunc, obj);
NWNX_PushArgumentInt(NWNX_Data, sFunc, NWNX_DATA_TYPE_OBJECT);
NWNX_CallFunction(NWNX_Data, sFunc);
}
void NWNX_Data_Array_Set_Str(object obj, string tag, int index, string element)
{
string sFunc = "ArraySet";
NWNX_PushArgumentString(NWNX_Data, sFunc, element);
NWNX_PushArgumentInt(NWNX_Data, sFunc, index);
NWNX_PushArgumentString(NWNX_Data, sFunc, tag);
NWNX_PushArgumentObject(NWNX_Data, sFunc, obj);
NWNX_PushArgumentInt(NWNX_Data, sFunc, NWNX_DATA_TYPE_STRING);
NWNX_CallFunction(NWNX_Data, sFunc);
WriteTimestampedLogEntry("WARNING: NWNX_Data is deprecated. You should migrate to Array (see inc_array)");
Array_Set_Obj(tag, index, element, obj);
}

View File

@@ -0,0 +1,483 @@
// 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
/// @name Cleric Domains
/// @anchor cleric_domains
///
/// The clerical domains.
/// @{
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
/// @brief A memorised spell structure.
struct NWNX_Creature_MemorisedSpell
{
int id; ///< Spell ID
int ready; ///< Whether the spell can be cast
int meta; ///< Metamagic type, if any
int domain; ///< Clerical domain, if any
};
/// @brief Gets the count of memorised spells for a creature's class at a level.
/// @param creature The creature object.
/// @param class The class id from classes.2da. (Not class index 0-2)
/// @param level The spell level.
/// @return The memorised spell count.
int NWNX_Creature_GetMemorisedSpellCountByLevel(object creature, int class, int level);
/// @brief Gets the memorised spell at a class level's index.
/// @param creature The creature object.
/// @param class The class id from classes.2da. (Not class index 0-2)
/// @param level The spell level.
/// @param index The index. Index bounds: 0 <= index < NWNX_Creature_GetMemorisedSpellCountByLevel().
/// @return An NWNX_Creature_MemorisedSpell() struct.
struct NWNX_Creature_MemorisedSpell NWNX_Creature_GetMemorisedSpell(object creature, int class, int level, int index);
/// @brief Sets the memorised spell at a class level's index.
/// @param creature The creature object.
/// @param class The class id from classes.2da. (Not class index 0-2)
/// @param level The spell level.
/// @param index The index. Index bounds: 0 <= index < NWNX_Creature_GetMemorisedSpellCountByLevel().
/// @param spell An NWNX_Creature_MemorisedSpell() struct.
void NWNX_Creature_SetMemorisedSpell(object creature, int class, int level, int index, struct NWNX_Creature_MemorisedSpell spell);
/// @brief Gets the known spell count (innate casting) at a class level.
/// @param creature The creature object.
/// @param class The class id from classes.2da. (Not class index 0-2)
/// @param level The spell level.
/// @return The known spell count.
int NWNX_Creature_GetKnownSpellCount(object creature, int class, int level);
/// @brief Gets the known spell at a class level's index.
/// @param creature The creature object.
/// @param class The class id from classes.2da. (Not class index 0-2)
/// @param level The spell level.
/// @param index The index. Index bounds: 0 <= index < NWNX_Creature_GetKnownSpellCount().
/// @return The spell id.
int NWNX_Creature_GetKnownSpell(object creature, int class, int level, int index);
/// @brief Clear a specific spell from the creature's spellbook for class
/// @param creature The creature object.
/// @param class The class id from classes.2da. (Not class index 0-2)
/// @param spellId The spell to clear.
void NWNX_Creature_ClearMemorisedKnownSpells(object creature, int class, int spellId);
/// @brief Clear the memorised spell of the creature for the class, level and index.
/// @param creature The creature object.
/// @param class The class id from classes.2da. (Not class index 0-2)
/// @param level The spell level.
/// @param index The index. Index bounds: 0 <= index < NWNX_Creature_GetMemorisedSpellCountByLevel().
void NWNX_Creature_ClearMemorisedSpell(object creature, int class, int level, int index);
/// @brief Get the soundset index for creature.
/// @param creature The creature object.
/// @return The soundset used by the creature.
int NWNX_Creature_GetSoundset(object creature);
/// @brief Set the soundset index for creature.
/// @param creature The creature object.
/// @param soundset The soundset index.
void NWNX_Creature_SetSoundset(object creature, int soundset);
/// @brief Sets the creature gender.
/// @param creature The creature object.
/// @param gender The GENDER_ constant.
void NWNX_Creature_SetGender(object creature, int gender);
/// @brief Restore all creature spells per day for given level.
/// @param creature The creature object.
/// @param level The level to restore. If -1, all spells are restored.
void NWNX_Creature_RestoreSpells(object creature, int level = -1);
/// @brief Gets one of creature's domains.
/// @param creature The creature object.
/// @param class The class id from classes.2da. (Not class index 0-2)
/// @param index The first or second domain.
/// @deprecated Use GetDomain(). This will be removed in future NWNX releases.
int NWNX_Creature_GetDomain(object creature, int class, int index);
/// @brief Gets the creature's specialist school.
/// @param creature The creature object.
/// @param class The class id from classes.2da. (Not class index 0-2)
/// @deprecated Use GetSpecialization(). This will be removed in future NWNX releases.
int NWNX_Creature_GetSpecialization(object creature, int class);
/// @brief Get the number of uses left of a spell.
/// @note This function is for caster classes that don't need to memorize spells.
/// @param oCreature The creature.
/// @param nSpellID The spell ID.
/// @param nMultiClass The position of the class to check, 0-2
/// @param nDomainLevel The domain level if checking a domain spell.
/// @param nMetaMagic A METAMAGIC_* constant.
/// @return The number of spell uses left or 0 on error.
int NWNX_Creature_GetSpellUsesLeft(object oCreature, int nSpellID, int nMultiClass, int nDomainLevel = 0, int nMetaMagic = METAMAGIC_NONE);
/// @brief Get the number of memorized ready spells by spellid.
/// @note This function is for caster classes that need to memorize spells.
/// @param oCreature The creature.
/// @param nSpellID The spell ID.
/// @param nMultiClass The position of the class to check, 0-2
/// @param nMetaMagic A METAMAGIC_* constant.
/// @return The number of spell uses left or 0 on error.
int NWNX_Creature_GetMemorizedSpellReadyCount(object oCreature, int nSpellID, int nMultiClass, int nMetaMagic = METAMAGIC_NONE);
/// @brief Set whether an effect icon is flashing or not.
/// @param oCreature The target creature.
/// @param nIconId The icon id, see effecticons.2da.
/// @param bFlashing TRUE for flashing, FALSE for not flashing.
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
/// @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 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 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 Accessorize an EffectVisualEffect(), making it undispellable and unable to be removed by resting or death.
/// @note If linked with a non-visualeffect or a non-accessorized visualeffect it *will* get removed.
/// @param eEffect An EffectVisualEffect(), does not work for other effect types.
/// @return The accessorized effect or an unchanged effect if not an EffectVisualEffect().
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
/// @brief Convert an object id to the actual object.
/// @param id The object id.
/// @return An object from the provided object ID.
/// @remark This is the counterpart to ObjectToString.
/// @deprecated Use the basegame StringToObject() function. This will be removed in a future NWNX release.
object NWNX_Object_StringToObject(string id);
/// @brief Check if an item can fit in an object's inventory.
/// @param obj The object with an inventory.
/// @param baseitem The base item id to check for a fit.
/// @return TRUE if an item of base item type can fit in object's inventory
int NWNX_Object_CheckFit(object obj, int baseitem);
/// @brief Add an effect to an object that displays an icon and has no other effect.
/// @remark See effecticons.2da for a list of possible effect icons.
/// @param obj The object to apply the effect.
/// @param nIcon The icon id.
/// @param fDuration If specified the effect will be temporary and last this length in seconds, otherwise the effect
/// will be permanent.
void NWNX_Object_AddIconEffect(object obj, int nIcon, float fDuration=0.0);
/// @brief Remove an icon effect from an object that was added by the NWNX_Object_AddIconEffect() function.
/// @param obj The object.
/// @param nIcon The icon id.
void NWNX_Object_RemoveIconEffect(object obj, int nIcon);
/// @brief Cause oObject to face fDirection.
/// @note This function is almost identical to SetFacing(), the only difference being that it allows you to specify
/// the target object without the use of AssignCommand(). This is useful when you want to change the facing of an object
/// in an ExecuteScriptChunk() call where AssignCommand() does not work.
/// @param oObject The object to change its facing of
/// @param fDirection The direction the object should face
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
/// @param str The string to search.
/// @param regex The regular expression to use when searching.
/// @return TRUE if string matches the regular expression.
int NWNX_Regex_Search(string str, string regex);
/// @brief Replaces any matches of the regular expression with a string.
/// @param str The string to search.
/// @param regex The regular expression to use when searching.
/// @param replace The string to replace the matches with.
/// @param firstOnly Set to TRUE to only replace the first match.
/// @return A new string with any replacements made.
string NWNX_Regex_Replace(string str, string regex, string replace = "", int firstOnly = FALSE);
/// @brief Returns all matches in a string that match the regular expression.
/// @param str The string to search.
/// @param regex The regular expression to use.
/// @return A json array with json arrays of all (sub)matches. Returns JsonNull() on error.
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
/// @brief Determines if the supplied resref exists.
/// @param resref The resref to check.
/// @param type The @ref resref_types "Resref Type".
/// @return TRUE/FALSE
int NWNX_Util_IsValidResRef(string resref, int type = RESTYPE_UTC);
/// @anchor twoda_row_count
/// @brief Gets the row count for a 2da.
/// @param str The 2da to check (do not include the .2da).
/// @return The amount of rows in the 2da.
int NWNX_Util_Get2DARowCount(string str);
/// @brief Gets the contents of a .nss script file as a string.
/// @param sScriptName The name of the script to get the contents of.
/// @param nMaxLength The max length of the return string, -1 to get everything
/// @return The script file contents or "" on error.
string NWNX_Util_GetNSSContents(string sScriptName, int nMaxLength = -1);
/// @brief Get the ticks per second of the server.
/// @remark Useful to dynamically detect lag and adjust behavior accordingly.
/// @return The ticks per second.
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();
}

View File

@@ -3,8 +3,6 @@
/// @{
/// @file nwnx_dialog.nss
#include "nwnx"
const string NWNX_Dialog = "NWNX_Dialog"; ///< @private
/// @name Dialog Node Types
@@ -80,60 +78,46 @@ void NWNX_Dialog_End(object oObject);
int NWNX_Dialog_GetCurrentNodeType()
{
string sFunc = "GetCurrentNodeType";
NWNX_CallFunction(NWNX_Dialog, sFunc);
return NWNX_GetReturnValueInt(NWNX_Dialog, sFunc);
NWNXCall(NWNX_Dialog, "GetCurrentNodeType");
return NWNXPopInt();
}
int NWNX_Dialog_GetCurrentScriptType()
{
string sFunc = "GetCurrentScriptType";
NWNX_CallFunction(NWNX_Dialog, sFunc);
return NWNX_GetReturnValueInt(NWNX_Dialog, sFunc);
NWNXCall(NWNX_Dialog, "GetCurrentScriptType");
return NWNXPopInt();
}
int NWNX_Dialog_GetCurrentNodeID()
{
string sFunc = "GetCurrentNodeID";
NWNX_CallFunction(NWNX_Dialog, sFunc);
return NWNX_GetReturnValueInt(NWNX_Dialog, sFunc);
NWNXCall(NWNX_Dialog, "GetCurrentNodeID");
return NWNXPopInt();
}
int NWNX_Dialog_GetCurrentNodeIndex()
{
string sFunc = "GetCurrentNodeIndex";
NWNX_CallFunction(NWNX_Dialog, sFunc);
return NWNX_GetReturnValueInt(NWNX_Dialog, sFunc);
NWNXCall(NWNX_Dialog, "GetCurrentNodeIndex");
return NWNXPopInt();
}
string NWNX_Dialog_GetCurrentNodeText(int language=NWNX_DIALOG_LANGUAGE_ENGLISH, int gender=GENDER_MALE)
{
string sFunc = "GetCurrentNodeText";
NWNX_PushArgumentInt(NWNX_Dialog, sFunc, gender);
NWNX_PushArgumentInt(NWNX_Dialog, sFunc, language);
NWNX_CallFunction(NWNX_Dialog, sFunc);
return NWNX_GetReturnValueString(NWNX_Dialog, sFunc);
NWNXPushInt(gender);
NWNXPushInt(language);
NWNXCall(NWNX_Dialog, "GetCurrentNodeText");
return NWNXPopString();
}
void NWNX_Dialog_SetCurrentNodeText(string text, int language=NWNX_DIALOG_LANGUAGE_ENGLISH, int gender=GENDER_MALE)
{
string sFunc = "SetCurrentNodeText";
NWNX_PushArgumentInt(NWNX_Dialog, sFunc, gender);
NWNX_PushArgumentInt(NWNX_Dialog, sFunc, language);
NWNX_PushArgumentString(NWNX_Dialog, sFunc, text);
NWNX_CallFunction(NWNX_Dialog, sFunc);
NWNXPushInt(gender);
NWNXPushInt(language);
NWNXPushString(text);
NWNXCall(NWNX_Dialog, "SetCurrentNodeText");
}
void NWNX_Dialog_End(object oObject)
{
string sFunc = "End";
NWNX_PushArgumentObject(NWNX_Dialog, sFunc, oObject);
NWNX_CallFunction(NWNX_Dialog, sFunc);
NWNXPushObject(oObject);
NWNXCall(NWNX_Dialog, "End");
}

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();
}

View File

@@ -2,7 +2,6 @@
/// @brief Replacement for ValidateCharacter: ELC & ILR
/// @{
/// @file nwnx_elc.nss
#include "nwnx"
const string NWNX_ELC = "NWNX_ELC"; ///< @private
@@ -21,11 +20,8 @@ const int NWNX_ELC_VALIDATION_FAILURE_TYPE_CUSTOM = 6;
/// @anchor elc_fail_subtype
/// @name ELC Failure Subtypes
/// @note By default these constants are commented out to avoid a
/// limitation on constants. Uncomment them as needed.
/// @{
const int NWNX_ELC_SUBTYPE_NONE = 0;
/*
const int NWNX_ELC_SUBTYPE_SERVER_LEVEL_RESTRICTION = 1;
const int NWNX_ELC_SUBTYPE_LEVEL_HACK = 2;
const int NWNX_ELC_SUBTYPE_COLORED_NAME = 3;
@@ -75,7 +71,7 @@ const int NWNX_ELC_SUBTYPE_SKILL_LIST_COMPARISON = 48;
const int NWNX_ELC_SUBTYPE_FEAT_LIST_COMPARISON = 49;
const int NWNX_ELC_SUBTYPE_MISC_SAVING_THROW = 50;
const int NWNX_ELC_SUBTYPE_NUM_FEAT_COMPARISON = 51;
*/
const int NWNX_ELC_SUBTYPE_NUM_MULTICLASS = 52;
/// @}
/// @brief Sets the script that runs whenever an ELC validation failure happens
@@ -150,95 +146,71 @@ int NWNX_ELC_GetValidationFailureSpellID();
void NWNX_ELC_SetELCScript(string sScript)
{
string sFunc = "SetELCScript";
NWNX_PushArgumentString(NWNX_ELC, sFunc, sScript);
NWNX_CallFunction(NWNX_ELC, sFunc);
NWNXPushString(sScript);
NWNXCall(NWNX_ELC, "SetELCScript");
}
void NWNX_ELC_EnableCustomELCCheck(int bEnabled)
{
string sFunc = "EnableCustomELCCheck";
NWNX_PushArgumentInt(NWNX_ELC, sFunc, bEnabled);
NWNX_CallFunction(NWNX_ELC, sFunc);
NWNXPushInt(bEnabled);
NWNXCall(NWNX_ELC, "EnableCustomELCCheck");
}
void NWNX_ELC_SkipValidationFailure()
{
string sFunc = "SkipValidationFailure";
NWNX_CallFunction(NWNX_ELC, sFunc);
NWNXCall(NWNX_ELC, "SkipValidationFailure");
}
int NWNX_ELC_GetValidationFailureType()
{
string sFunc = "GetValidationFailureType";
NWNX_CallFunction(NWNX_ELC, sFunc);
return NWNX_GetReturnValueInt(NWNX_ELC, sFunc);
NWNXCall(NWNX_ELC, "GetValidationFailureType");
return NWNXPopInt();
}
int NWNX_ELC_GetValidationFailureSubType()
{
string sFunc = "GetValidationFailureSubType";
NWNX_CallFunction(NWNX_ELC, sFunc);
return NWNX_GetReturnValueInt(NWNX_ELC, sFunc);
NWNXCall(NWNX_ELC, "GetValidationFailureSubType");
return NWNXPopInt();
}
int NWNX_ELC_GetValidationFailureMessageStrRef()
{
string sFunc = "GetValidationFailureMessageStrRef";
NWNX_CallFunction(NWNX_ELC, sFunc);
return NWNX_GetReturnValueInt(NWNX_ELC, sFunc);
NWNXCall(NWNX_ELC, "GetValidationFailureMessageStrRef");
return NWNXPopInt();
}
void NWNX_ELC_SetValidationFailureMessageStrRef(int nStrRef)
{
string sFunc = "SetValidationFailureMessageStrRef";
NWNX_PushArgumentInt(NWNX_ELC, sFunc, nStrRef);
NWNX_CallFunction(NWNX_ELC, sFunc);
NWNXPushInt(nStrRef);
NWNXCall(NWNX_ELC, "SetValidationFailureMessageStrRef");
}
object NWNX_ELC_GetValidationFailureItem()
{
string sFunc = "GetValidationFailureItem";
NWNX_CallFunction(NWNX_ELC, sFunc);
return NWNX_GetReturnValueObject(NWNX_ELC, sFunc);
NWNXCall(NWNX_ELC, "GetValidationFailureItem");
return NWNXPopObject();
}
int NWNX_ELC_GetValidationFailureLevel()
{
string sFunc = "GetValidationFailureLevel";
NWNX_CallFunction(NWNX_ELC, sFunc);
return NWNX_GetReturnValueInt(NWNX_ELC, sFunc);
NWNXCall(NWNX_ELC, "GetValidationFailureLevel");
return NWNXPopInt();
}
int NWNX_ELC_GetValidationFailureSkillID()
{
string sFunc = "GetValidationFailureSkillID";
NWNX_CallFunction(NWNX_ELC, sFunc);
return NWNX_GetReturnValueInt(NWNX_ELC, sFunc);
NWNXCall(NWNX_ELC, "GetValidationFailureSkillID");
return NWNXPopInt();
}
int NWNX_ELC_GetValidationFailureFeatID()
{
string sFunc = "GetValidationFailureFeatID";
NWNX_CallFunction(NWNX_ELC, sFunc);
return NWNX_GetReturnValueInt(NWNX_ELC, sFunc);
NWNXCall(NWNX_ELC, "GetValidationFailureFeatID");
return NWNXPopInt();
}
int NWNX_ELC_GetValidationFailureSpellID()
{
string sFunc = "GetValidationFailureSpellID";
NWNX_CallFunction(NWNX_ELC, sFunc);
return NWNX_GetReturnValueInt(NWNX_ELC, sFunc);
NWNXCall(NWNX_ELC, "GetValidationFailureSpellID");
return NWNXPopInt();
}

View File

@@ -2,7 +2,6 @@
/// @brief Functions exposing additional encounter properties.
/// @{
/// @file nwnx_encounter.nss
#include "nwnx"
const string NWNX_Encounter = "NWNX_Encounter"; ///< @private
@@ -12,8 +11,13 @@ struct NWNX_Encounter_CreatureListEntry
string resref; ///< The resref.
float challengeRating; ///< The challenge rating.
int unique; ///< Creature will be unique to the encounter.
int alreadyUsed; //< Creature has already been used.
};
/// @brief Immediately destroys the specified encounter object.
/// @param encounter The encounter object.
void NWNX_Encounter_Destroy(object encounter);
/// @brief Get the number of creatures in the encounter list
/// @param encounter The encounter object.
/// @return The number of creatures in the encounter list.
@@ -43,7 +47,7 @@ void NWNX_Encounter_SetFactionId(object encounter, int factionId);
/// @brief Get if encounter is player triggered only.
/// @param encounter The encounter object.
/// @return TRUE is encounter is player triggered only.
/// @return TRUE if encounter is player triggered only.
int NWNX_Encounter_GetPlayerTriggeredOnly(object encounter);
/// @brief Set if encounter is player triggered only.
@@ -51,6 +55,16 @@ int NWNX_Encounter_GetPlayerTriggeredOnly(object encounter);
/// @param playerTriggeredOnly TRUE/FALSE
void NWNX_Encounter_SetPlayerTriggeredOnly(object encounter, int playerTriggeredOnly);
/// @brief Get if the encounter respawns or not.
/// @param encounter The encounter object.
/// @return TRUE if the encounter does respawn, FALSE otherwise.
int NWNX_Encounter_GetCanReset(object encounter);
/// @brief Set if the encounter respawns or not.
/// @param encounter The encounter object.
/// @param reset Does the encounter respawn TRUE or FALSE.
void NWNX_Encounter_SetCanReset(object encounter, int reset);
/// @brief Get the reset time of encounter.
/// @param encounter The encounter object.
/// @return The seconds the encounter is defined to reset.
@@ -61,104 +75,192 @@ int NWNX_Encounter_GetResetTime(object encounter);
/// @param resetTime The seconds the encounter will reset.
void NWNX_Encounter_SetResetTime(object encounter, int resetTime);
/// @brief Get the number of spawn points of encounter.
/// @param encounter The encounter object.
/// @return The count of the spawn points for the encounter.
int NWNX_Encounter_GetNumberOfSpawnPoints(object encounter);
/// @brief Gets the spawn point list entry at the specified index
/// @param encounter The encounter object.
/// @param index The index of the spawn point in the encounter list.
/// @return Location of spawn point.
location NWNX_Encounter_GetSpawnPointByIndex(object encounter, int index);
/// @brief Get the minimum amount of creatures that encounter will spawn.
/// @param encounter The encounter object.
/// @return the minimal amount.
int NWNX_Encounter_GetMinNumSpawned(object encounter);
/// @brief Get the maximum amount of creatures that encounter will spawn.
/// @param encounter The encounter object.
/// @return the maximal amount.
int NWNX_Encounter_GetMaxNumSpawned(object encounter);
/// @brief Get the current number of creatures that are spawned and alive
/// @param encounter The encounter object.
/// @return amount of creatures
int NWNX_Encounter_GetCurrentNumSpawned(object encounter);
/// @brief Get the geometry of an encounter
/// @param oEncounter: The encounter object.
/// @return A string of vertex positions.
string NWNX_Encounter_GetGeometry(object oEncounter);
/// @brief Set the geometry of an encounter with a list of vertex positions
/// @param oTrigger The encounter object.
/// @param sGeometry Needs to be in the following format -> {x.x, y.y, z.z} or {x.x, y.y}
/// Example Geometry: "{1.0, 1.0, 0.0}{4.0, 1.0, 0.0}{4.0, 4.0, 0.0}{1.0, 4.0, 0.0}"
///
/// @remark The Z position is optional and will be calculated dynamically based
/// on terrain height if it's not provided.
///
/// @remark The minimum number of vertices is 3.
void NWNX_Encounter_SetGeometry(object oTrigger, string sGeometry);
/// @}
void NWNX_Encounter_Destroy(object encounter)
{
NWNXPushObject(encounter);
NWNXCall(NWNX_Encounter, "Destroy");
}
int NWNX_Encounter_GetNumberOfCreaturesInEncounterList(object encounter)
{
string sFunc = "GetNumberOfCreaturesInEncounterList";
NWNX_PushArgumentObject(NWNX_Encounter, sFunc, encounter);
NWNX_CallFunction(NWNX_Encounter, sFunc);
return NWNX_GetReturnValueInt(NWNX_Encounter, sFunc);
NWNXPushObject(encounter);
NWNXCall(NWNX_Encounter, "GetNumberOfCreaturesInEncounterList");
return NWNXPopInt();
}
struct NWNX_Encounter_CreatureListEntry NWNX_Encounter_GetEncounterCreatureByIndex(object encounter, int index)
{
string sFunc = "GetEncounterCreatureByIndex";
struct NWNX_Encounter_CreatureListEntry creatureEntry;
NWNX_PushArgumentInt(NWNX_Encounter, sFunc, index);
NWNX_PushArgumentObject(NWNX_Encounter, sFunc, encounter);
NWNX_CallFunction(NWNX_Encounter, sFunc);
creatureEntry.unique = NWNX_GetReturnValueInt(NWNX_Encounter, sFunc);
creatureEntry.challengeRating = NWNX_GetReturnValueFloat(NWNX_Encounter, sFunc);
creatureEntry.resref = NWNX_GetReturnValueString(NWNX_Encounter, sFunc);
NWNXPushInt(index);
NWNXPushObject(encounter);
NWNXCall(NWNX_Encounter, "GetEncounterCreatureByIndex");
creatureEntry.alreadyUsed = NWNXPopInt();
creatureEntry.unique = NWNXPopInt();
creatureEntry.challengeRating = NWNXPopFloat();
creatureEntry.resref = NWNXPopString();
return creatureEntry;
}
void NWNX_Encounter_SetEncounterCreatureByIndex(object encounter, int index, struct NWNX_Encounter_CreatureListEntry creatureEntry)
{
string sFunc = "SetEncounterCreatureByIndex";
NWNX_PushArgumentInt(NWNX_Encounter, sFunc, creatureEntry.unique);
NWNX_PushArgumentFloat(NWNX_Encounter, sFunc, creatureEntry.challengeRating);
NWNX_PushArgumentString(NWNX_Encounter, sFunc, creatureEntry.resref);
NWNX_PushArgumentInt(NWNX_Encounter, sFunc, index);
NWNX_PushArgumentObject(NWNX_Encounter, sFunc, encounter);
NWNX_CallFunction(NWNX_Encounter, sFunc);
NWNXPushInt(creatureEntry.alreadyUsed);
NWNXPushInt(creatureEntry.unique);
NWNXPushFloat(creatureEntry.challengeRating);
NWNXPushString(creatureEntry.resref);
NWNXPushInt(index);
NWNXPushObject(encounter);
NWNXCall(NWNX_Encounter, "SetEncounterCreatureByIndex");
}
int NWNX_Encounter_GetFactionId(object encounter)
{
string sFunc = "GetFactionId";
NWNX_PushArgumentObject(NWNX_Encounter, sFunc, encounter);
NWNX_CallFunction(NWNX_Encounter, sFunc);
return NWNX_GetReturnValueInt(NWNX_Encounter, sFunc);
NWNXPushObject(encounter);
NWNXCall(NWNX_Encounter, "GetFactionId");
return NWNXPopInt();
}
void NWNX_Encounter_SetFactionId(object encounter, int factionId)
{
string sFunc = "SetFactionId";
NWNX_PushArgumentInt(NWNX_Encounter, sFunc, factionId);
NWNX_PushArgumentObject(NWNX_Encounter, sFunc, encounter);
NWNX_CallFunction(NWNX_Encounter, sFunc);
NWNXPushInt(factionId);
NWNXPushObject(encounter);
NWNXCall(NWNX_Encounter, "SetFactionId");
}
int NWNX_Encounter_GetPlayerTriggeredOnly(object encounter)
{
string sFunc = "GetPlayerTriggeredOnly";
NWNX_PushArgumentObject(NWNX_Encounter, sFunc, encounter);
NWNX_CallFunction(NWNX_Encounter, sFunc);
return NWNX_GetReturnValueInt(NWNX_Encounter, sFunc);
NWNXPushObject(encounter);
NWNXCall(NWNX_Encounter, "GetPlayerTriggeredOnly");
return NWNXPopInt();
}
void NWNX_Encounter_SetPlayerTriggeredOnly(object encounter, int playerTriggeredOnly)
{
string sFunc = "SetPlayerTriggeredOnly";
NWNX_PushArgumentInt(NWNX_Encounter, sFunc, playerTriggeredOnly);
NWNX_PushArgumentObject(NWNX_Encounter, sFunc, encounter);
NWNXPushInt(playerTriggeredOnly);
NWNXPushObject(encounter);
NWNXCall(NWNX_Encounter, "SetPlayerTriggeredOnly");
}
NWNX_CallFunction(NWNX_Encounter, sFunc);
int NWNX_Encounter_GetCanReset(object encounter)
{
NWNXPushObject(encounter);
NWNXCall(NWNX_Encounter, "GetCanReset");
return NWNXPopInt();
}
void NWNX_Encounter_SetCanReset(object encounter, int reset)
{
NWNXPushInt(reset);
NWNXPushObject(encounter);
NWNXCall(NWNX_Encounter, "SetCanReset");
}
int NWNX_Encounter_GetResetTime(object encounter)
{
string sFunc = "GetResetTime";
NWNX_PushArgumentObject(NWNX_Encounter, sFunc, encounter);
NWNX_CallFunction(NWNX_Encounter, sFunc);
return NWNX_GetReturnValueInt(NWNX_Encounter, sFunc);
NWNXPushObject(encounter);
NWNXCall(NWNX_Encounter, "GetResetTime");
return NWNXPopInt();
}
void NWNX_Encounter_SetResetTime(object encounter, int resetTime)
{
string sFunc = "SetResetTime";
NWNX_PushArgumentInt(NWNX_Encounter, sFunc, resetTime);
NWNX_PushArgumentObject(NWNX_Encounter, sFunc, encounter);
NWNX_CallFunction(NWNX_Encounter, sFunc);
NWNXPushInt(resetTime);
NWNXPushObject(encounter);
NWNXCall(NWNX_Encounter, "SetResetTime");
}
int NWNX_Encounter_GetNumberOfSpawnPoints(object encounter)
{
NWNXPushObject(encounter);
NWNXCall(NWNX_Encounter, "GetNumberOfSpawnPoints");
return NWNXPopInt();
}
location NWNX_Encounter_GetSpawnPointByIndex(object encounter, int index)
{
NWNXPushInt(index);
NWNXPushObject(encounter);
NWNXCall(NWNX_Encounter, "GetSpawnPointByIndex");
float fOrientation = NWNXPopFloat();
vector vPosition = NWNXPopVector();
return Location(GetArea(encounter), vPosition, fOrientation);
}
int NWNX_Encounter_GetMinNumSpawned(object encounter)
{
NWNXPushObject(encounter);
NWNXCall(NWNX_Encounter, "GetMinNumSpawned");
return NWNXPopInt();
}
int NWNX_Encounter_GetMaxNumSpawned(object encounter)
{
NWNXPushObject(encounter);
NWNXCall(NWNX_Encounter, "GetMaxNumSpawned");
return NWNXPopInt();
}
int NWNX_Encounter_GetCurrentNumSpawned(object encounter)
{
NWNXPushObject(encounter);
NWNXCall(NWNX_Encounter, "GetCurrentNumSpawned");
return NWNXPopInt();
}
string NWNX_Encounter_GetGeometry(object oEncounter)
{
NWNXPushObject(oEncounter);
NWNXCall(NWNX_Encounter, "GetGeometry");
return NWNXPopString();
}
void NWNX_Encounter_SetGeometry(object oEncounter, string sGeometry)
{
NWNXPushString(sGeometry);
NWNXPushObject(oEncounter);
NWNXCall(NWNX_Encounter, "SetGeometry");
}

File diff suppressed because it is too large Load Diff

62
_module/nss/nwnx_feat.nss Normal file
View File

@@ -0,0 +1,62 @@
/// @addtogroup feat Feat
/// @brief Define feat bonuses/penalties
/// @{
/// @file nwnx_feat.nss
const string NWNX_Feat = "NWNX_Feat"; ///< @private
/// @name Feat Modifiers
/// @anchor feat_modifiers
///
/// @{
const int NWNX_FEAT_MODIFIER_INVALID = 0;
const int NWNX_FEAT_MODIFIER_AB = 1;
const int NWNX_FEAT_MODIFIER_ABILITY = 2;
const int NWNX_FEAT_MODIFIER_ABVSRACE = 3;
const int NWNX_FEAT_MODIFIER_AC = 4;
const int NWNX_FEAT_MODIFIER_ACVSRACE = 5;
const int NWNX_FEAT_MODIFIER_ARCANESPELLFAILURE = 6;
const int NWNX_FEAT_MODIFIER_CONCEALMENT = 7;
const int NWNX_FEAT_MODIFIER_DMGIMMUNITY = 8;
const int NWNX_FEAT_MODIFIER_DMGREDUCTION = 9;
const int NWNX_FEAT_MODIFIER_DMGRESIST = 10;
const int NWNX_FEAT_MODIFIER_IMMUNITY = 11;
const int NWNX_FEAT_MODIFIER_MOVEMENTSPEED = 12;
const int NWNX_FEAT_MODIFIER_REGENERATION = 13;
const int NWNX_FEAT_MODIFIER_SAVE = 14;
const int NWNX_FEAT_MODIFIER_SAVEVSRACE = 15;
const int NWNX_FEAT_MODIFIER_SAVEVSTYPE = 16;
const int NWNX_FEAT_MODIFIER_SAVEVSTYPERACE = 17;
const int NWNX_FEAT_MODIFIER_SPELLIMMUNITY = 18;
const int NWNX_FEAT_MODIFIER_SRCHARGEN = 19;
const int NWNX_FEAT_MODIFIER_SRINCLEVEL = 20;
const int NWNX_FEAT_MODIFIER_SPELLSAVEDC = 21;
const int NWNX_FEAT_MODIFIER_BONUSSPELL = 22;
const int NWNX_FEAT_MODIFIER_TRUESEEING = 23;
const int NWNX_FEAT_MODIFIER_SEEINVISIBLE = 24;
const int NWNX_FEAT_MODIFIER_ULTRAVISION = 25;
const int NWNX_FEAT_MODIFIER_HASTE = 26;
const int NWNX_FEAT_MODIFIER_VISUALEFFECT = 27;
const int NWNX_FEAT_MODIFIER_SPELLSAVEDCFORSCHOOL = 28;
const int NWNX_FEAT_MODIFIER_SPELLSAVEDCFORSPELL = 29;
const int NWNX_FEAT_MODIFIER_DAMAGE = 30;
///@}
/// @brief Sets a feat modifier.
/// @param iFeat The Feat constant or value in feat.2da.
/// @param iMod The @ref feat_modifiers "feat modifier" to set.
/// @param iParam1, iParam2, iParam3, iParam4 The parameters for this feat modifier.
void NWNX_Feat_SetFeatModifier(int iFeat, int iMod, int iParam1 = 0xDEADBEEF, int iParam2 = 0xDEADBEEF, int iParam3 = 0xDEADBEEF, int iParam4 = 0xDEADBEEF);
/// @}
void NWNX_Feat_SetFeatModifier(int iFeat, int iMod, int iParam1 = 0xDEADBEEF, int iParam2 = 0xDEADBEEF, int iParam3 = 0xDEADBEEF, int iParam4 = 0xDEADBEEF)
{
NWNXPushInt(iParam4);
NWNXPushInt(iParam3);
NWNXPushInt(iParam2);
NWNXPushInt(iParam1);
NWNXPushInt(iMod);
NWNXPushInt(iFeat);
NWNXCall(NWNX_Feat, "SetFeatModifier");
}

View File

@@ -0,0 +1,78 @@
/// @ingroup feat
/// @file nwnx_feat_2da.nss
/// @brief Parse a column in the feat.2da to load the modifiers.
#include "nwnx_feat"
/// @ingroup feat
/// @brief Translate a modifier type from a string to its constant.
/// @param featMod The string representation of the constant.
/// @return The constant for the feat modifier.
int NWNX_Feat_GetModifierConstant(string featMod);
/// @ingroup feat
/// @brief Loops through feat.2da and checks for the column for feat modifications and sets them.
/// @param sColumnName The column name in the feat.2da that defines the 2da for the feat mods.
void NWNX_Feat_LoadFeatModifiers(string sColumnName = "FeatModsTable");
int NWNX_Feat_GetModifierConstant(string featMod)
{
if (featMod == "AB") return NWNX_FEAT_MODIFIER_AB;
else if (featMod == "ABILITY") return NWNX_FEAT_MODIFIER_ABILITY;
else if (featMod == "ABVSRACE") return NWNX_FEAT_MODIFIER_ABVSRACE;
else if (featMod == "AC") return NWNX_FEAT_MODIFIER_AC;
else if (featMod == "ACVSRACE") return NWNX_FEAT_MODIFIER_ACVSRACE;
else if (featMod == "ARCANESPELLFAILURE") return NWNX_FEAT_MODIFIER_ARCANESPELLFAILURE;
else if (featMod == "BONUSSPELL") return NWNX_FEAT_MODIFIER_BONUSSPELL;
else if (featMod == "CONCEALMENT") return NWNX_FEAT_MODIFIER_CONCEALMENT;
else if (featMod == "DMGREDUCTION") return NWNX_FEAT_MODIFIER_DMGREDUCTION;
else if (featMod == "DMGRESIST") return NWNX_FEAT_MODIFIER_DMGRESIST;
else if (featMod == "DMGIMMUNITY") return NWNX_FEAT_MODIFIER_DMGIMMUNITY;
else if (featMod == "IMMUNITY") return NWNX_FEAT_MODIFIER_IMMUNITY;
else if (featMod == "HASTE") return NWNX_FEAT_MODIFIER_HASTE;
else if (featMod == "MOVEMENTSPEED") return NWNX_FEAT_MODIFIER_MOVEMENTSPEED;
else if (featMod == "REGENERATION") return NWNX_FEAT_MODIFIER_REGENERATION;
else if (featMod == "SAVE") return NWNX_FEAT_MODIFIER_SAVE;
else if (featMod == "SAVEVSRACE") return NWNX_FEAT_MODIFIER_SAVEVSRACE;
else if (featMod == "SAVEVSTYPE") return NWNX_FEAT_MODIFIER_SAVEVSTYPE;
else if (featMod == "SAVEVSTYPERACE") return NWNX_FEAT_MODIFIER_SAVEVSTYPERACE;
else if (featMod == "SEEINVISIBLE") return NWNX_FEAT_MODIFIER_SEEINVISIBLE;
else if (featMod == "SPELLIMMUNITY") return NWNX_FEAT_MODIFIER_SPELLIMMUNITY;
else if (featMod == "SRCHARGEN") return NWNX_FEAT_MODIFIER_SRCHARGEN;
else if (featMod == "SRINCLEVEL") return NWNX_FEAT_MODIFIER_SRINCLEVEL;
else if (featMod == "SPELLSAVEDC") return NWNX_FEAT_MODIFIER_SPELLSAVEDC;
else if (featMod == "TRUESEEING") return NWNX_FEAT_MODIFIER_TRUESEEING;
else if (featMod == "ULTRAVISION") return NWNX_FEAT_MODIFIER_ULTRAVISION;
else if (featMod == "VISUALEFFECT") return NWNX_FEAT_MODIFIER_VISUALEFFECT;
else if (featMod == "SPELLSAVEDCFORSCHOOL") return NWNX_FEAT_MODIFIER_SPELLSAVEDCFORSCHOOL;
else if (featMod == "SPELLSAVEDCFORSPELL") return NWNX_FEAT_MODIFIER_SPELLSAVEDCFORSPELL;
return NWNX_FEAT_MODIFIER_INVALID;
}
void NWNX_Feat_LoadFeatModifiers(string sColumnName = "FeatModsTable")
{
int iFeatRows = Get2DARowCount("feat");
int iFeat;
for (iFeat = 0; iFeat < iFeatRows; iFeat++)
{
string sFeatModTable = Get2DAString("feat", sColumnName, iFeat);
if(sFeatModTable != "")
{
int iFeatModRows = Get2DARowCount(sFeatModTable);
int iFeatMod;
for (iFeatMod = 0; iFeatMod < iFeatModRows; iFeatMod++)
{
string sType = Get2DAString(sFeatModTable, "Type", iFeatMod);
string sParam1 = Get2DAString(sFeatModTable, "Param1", iFeatMod);
string sParam2 = Get2DAString(sFeatModTable, "Param2", iFeatMod);
string sParam3 = Get2DAString(sFeatModTable, "Param3", iFeatMod);
string sParam4 = Get2DAString(sFeatModTable, "Param4", iFeatMod);
int iParam1 = sParam1 == "" ? 0xDEADBEEF : StringToInt(sParam1);
int iParam2 = sParam2 == "" ? 0xDEADBEEF : StringToInt(sParam2);
int iParam3 = sParam3 == "" ? 0xDEADBEEF : StringToInt(sParam3);
int iParam4 = sParam4 == "" ? 0xDEADBEEF : StringToInt(sParam4);
NWNX_Feat_SetFeatModifier(iFeat, NWNX_Feat_GetModifierConstant(sType), iParam1, iParam2, iParam3, iParam4);
}
}
}
}

View File

@@ -10,55 +10,33 @@
/// * -1 = Personal state is not set for Message
/// @{
/// @file nwnx_feedback.nss
#include "nwnx"
const string NWNX_Feedback = "NWNX_Feedback"; ///< @private
/// @name Combat Log Message Types
/// @anchor combat_log_msgs
/// @{
const int NWNX_FEEDBACK_COMBATLOG_SIMPLE_ADJECTIVE = 1;
/*
const int NWNX_FEEDBACK_COMBATLOG_SIMPLE_DAMAGE = 2;
const int NWNX_FEEDBACK_COMBATLOG_COMPLEX_DAMAGE = 3;
const int NWNX_FEEDBACK_COMBATLOG_COMPLEX_DEATH = 4;
const int NWNX_FEEDBACK_COMBATLOG_COMPLEX_ATTACK = 5;
const int NWNX_FEEDBACK_COMBATLOG_SPECIAL_ATTACK = 6;
const int NWNX_FEEDBACK_COMBATLOG_SAVING_THROW = 7;
const int NWNX_FEEDBACK_COMBATLOG_CAST_SPELL = 8;
const int NWNX_FEEDBACK_COMBATLOG_USE_SKILL = 9;
const int NWNX_FEEDBACK_COMBATLOG_SPELL_RESISTANCE = 10;
const int NWNX_FEEDBACK_COMBATLOG_FEEDBACK = 11; // NOTE: This hides ALL feedback messages, to hide individual messages use NWNX_Feedback_SetFeedbackMessageHidden()
const int NWNX_FEEDBACK_COMBATLOG_COUNTERSPELL = 12;
const int NWNX_FEEDBACK_COMBATLOG_TOUCHATTACK = 13;
const int NWNX_FEEDBACK_COMBATLOG_INITIATIVE = 14;
const int NWNX_FEEDBACK_COMBATLOG_DISPEL_MAGIC = 15;
const int NWNX_FEEDBACK_COMBATLOG_POLYMORPH = 17;
const int NWNX_FEEDBACK_COMBATLOG_FEEDBACKSTRING = 18;
const int NWNX_FEEDBACK_COMBATLOG_VIBRATE = 19;
const int NWNX_FEEDBACK_COMBATLOG_UNLOCKACHIEVEMENT = 20;
// 1 -> Simple_Adjective: <charname> : <adjective described by strref>
// 2 -> Simple_Damage: <charname> damaged : <amount>
// 3 -> Complex_Damage: <charname> damages <charname> : <amount>
// 4 -> Complex_Death: <charname> killed <charname>
// 5 -> Complex_Attack: <charname> attacks <charname> : *hit* / *miss* / *parried* : (<attack roll> + <attack mod> = <modified total>)
// 6 -> Special_Attack: <charname> attempts <special attack> on <charname> : *success* / *failure* : (<attack roll> + <attack mod> = <modified roll>)
// 7 -> Saving_Throw: <charname> : <saving throw type> : *success* / *failure* : (<saving throw roll> + <saving throw modifier> = <modified total>)
// 8 -> Cast_Spell: <charname> casts <spell name> : Spellcraft check *failure* / *success*
// 9 -> Use_Skill: <charname> : <skill name> : *success* / *failure* : (<skill roll> + <skill modifier> = <modified total> vs <DC> )
// 10 -> Spell_Resistance: <charname> : Spell Resistance <SR value> : *success* / *failure*
// 11 -> Feedback: Reason skill/feat/ability failed.
// 12 -> Counterspel: <charname> casts <spell name> : *spell countered by* : <charname> casting <spell name>
// 13 -> TouchAttack: <charname> attempts <melee/ranged touch attack> on <charname> : *hit/miss/critical* : (<attack roll> + <attack mod> = <modified roll>)
// 14 -> Initiative: <charname> : Initiative Roll : <total> : (<roll> + <modifier> = <total>)
// 15 -> Dispel_Magic: Dispel Magic : <charname> : <spell name>, <spell name>, <spell name>...
// 17 -> Unused, probably
// 18 -> Same as 11, maybe. Might be unused too
// 19 -> Unused
// 20 -> Unused
*/
const int NWNX_FEEDBACK_COMBATLOG_SIMPLE_ADJECTIVE = 1; // Simple_Adjective: <charname> : <adjective described by strref>
const int NWNX_FEEDBACK_COMBATLOG_SIMPLE_DAMAGE = 2; // Simple_Damage: <charname> damaged : <amount>
const int NWNX_FEEDBACK_COMBATLOG_COMPLEX_DAMAGE = 3; // Complex_Damage: <charname> damages <charname> : <amount>
const int NWNX_FEEDBACK_COMBATLOG_COMPLEX_DEATH = 4; // Complex_Death: <charname> killed <charname>
const int NWNX_FEEDBACK_COMBATLOG_COMPLEX_ATTACK = 5; // Complex_Attack: <charname> attacks <charname> : *hit* / *miss* / *parried* : (<attack roll> + <attack mod> = <modified total>)
const int NWNX_FEEDBACK_COMBATLOG_SPECIAL_ATTACK = 6; // Special_Attack: <charname> attempts <special attack> on <charname> : *success* / *failure* : (<attack roll> + <attack mod> = <modified roll>)
const int NWNX_FEEDBACK_COMBATLOG_SAVING_THROW = 7; // Saving_Throw: <charname> : <saving throw type> : *success* / *failure* : (<saving throw roll> + <saving throw modifier> = <modified total>)
const int NWNX_FEEDBACK_COMBATLOG_CAST_SPELL = 8; // Cast_Spell: <charname> casts <spell name> : Spellcraft check *failure* / *success*
const int NWNX_FEEDBACK_COMBATLOG_USE_SKILL = 9; // Use_Skill: <charname> : <skill name> : *success* / *failure* : (<skill roll> + <skill modifier> = <modified total> vs <DC> )
const int NWNX_FEEDBACK_COMBATLOG_SPELL_RESISTANCE = 10; // Spell_Resistance: <charname> : Spell Resistance <SR value> : *success* / *failure*
const int NWNX_FEEDBACK_COMBATLOG_FEEDBACK = 11; // Reason skill/feat/ability failed, SendMessageToPC() NOTE: This hides ALL feedback messages, to hide individual messages use NWNX_Feedback_SetFeedbackMessageHidden()
const int NWNX_FEEDBACK_COMBATLOG_COUNTERSPELL = 12; // Counterspel: <charname> casts <spell name> : *spell countered by* : <charname> casting <spell name>
const int NWNX_FEEDBACK_COMBATLOG_TOUCHATTACK = 13; // TouchAttack: <charname> attempts <melee/ranged touch attack> on <charname> : *hit/miss/critical* : (<attack roll> + <attack mod> = <modified roll>)
const int NWNX_FEEDBACK_COMBATLOG_INITIATIVE = 14; // Initiative: <charname> : Initiative Roll : <total> : (<roll> + <modifier> = <total>)
const int NWNX_FEEDBACK_COMBATLOG_DISPEL_MAGIC = 15; // Dispel_Magic: Dispel Magic : <charname> : <spell name>, <spell name>, <spell name>...
const int NWNX_FEEDBACK_COMBATLOG_POLYMORPH = 17; // Doesn't go through the function that the plugin hooks, so does nothing.
const int NWNX_FEEDBACK_COMBATLOG_FEEDBACKSTRING = 18; // Custom feedback for objects requiring a key
const int NWNX_FEEDBACK_COMBATLOG_VIBRATE = 19; // Controller vibration
const int NWNX_FEEDBACK_COMBATLOG_UNLOCKACHIEVEMENT = 20; // Unlock Campaign Achievement
const int NWNX_FEEDBACK_COMBATLOG_POSTAURSTRING = 22; // PostString messages
const int NWNX_FEEDBACK_COMBATLOG_ENTERTARGETINGMODE = 23; // Enter Targeting Mode
/// @}
/// @name Feedback Message Types
@@ -66,7 +44,6 @@ const int NWNX_FEEDBACK_COMBATLOG_UNLOCKACHIEVEMENT = 20;
/// @{
const int NWNX_FEEDBACK_SKILL_CANT_USE = 0;
/*
/// Skill Feedback Messages
const int NWNX_FEEDBACK_SKILL_CANT_USE_TIMER = 1;
const int NWNX_FEEDBACK_SKILL_ANIMALEMPATHY_VALID_TARGETS = 2;
@@ -368,7 +345,6 @@ const int NWNX_FEEDBACK_CAMERA_CHASECAM = 258;
const int NWNX_FEEDBACK_SAVING = 225;
const int NWNX_FEEDBACK_SAVE_COMPLETE = 226;
*/
/// @}
/// @brief Gets if feedback message is hidden.
@@ -425,95 +401,69 @@ void NWNX_Feedback_SetCombatLogMessageMode(int bWhitelist);
int NWNX_Feedback_GetFeedbackMessageHidden(int nMessage, object oPC = OBJECT_INVALID)
{
string sFunc = "GetMessageHidden";
int nMessageType = 0;
NWNX_PushArgumentInt(NWNX_Feedback, sFunc, nMessage);
NWNX_PushArgumentInt(NWNX_Feedback, sFunc, nMessageType);
NWNX_PushArgumentObject(NWNX_Feedback, sFunc, oPC);
NWNX_CallFunction(NWNX_Feedback, sFunc);
return NWNX_GetReturnValueInt(NWNX_Feedback, sFunc);
NWNXPushInt(nMessage);
NWNXPushInt(0);
NWNXPushObject(oPC);
NWNXCall(NWNX_Feedback, "GetMessageHidden");
return NWNXPopInt();
}
void NWNX_Feedback_SetFeedbackMessageHidden(int nMessage, int isHidden, object oPC = OBJECT_INVALID)
{
string sFunc = "SetMessageHidden";
int nMessageType = 0;
NWNX_PushArgumentInt(NWNX_Feedback, sFunc, isHidden);
NWNX_PushArgumentInt(NWNX_Feedback, sFunc, nMessage);
NWNX_PushArgumentInt(NWNX_Feedback, sFunc, nMessageType);
NWNX_PushArgumentObject(NWNX_Feedback, sFunc, oPC);
NWNX_CallFunction(NWNX_Feedback, sFunc);
NWNXPushInt(isHidden);
NWNXPushInt(nMessage);
NWNXPushInt(0);
NWNXPushObject(oPC);
NWNXCall(NWNX_Feedback, "SetMessageHidden");
}
int NWNX_Feedback_GetCombatLogMessageHidden(int nMessage, object oPC = OBJECT_INVALID)
{
string sFunc = "GetMessageHidden";
int nMessageType = 1;
NWNXPushInt(nMessage);
NWNXPushInt(1);
NWNXPushObject(oPC);
NWNXCall(NWNX_Feedback, "GetMessageHidden");
NWNX_PushArgumentInt(NWNX_Feedback, sFunc, nMessage);
NWNX_PushArgumentInt(NWNX_Feedback, sFunc, nMessageType);
NWNX_PushArgumentObject(NWNX_Feedback, sFunc, oPC);
NWNX_CallFunction(NWNX_Feedback, sFunc);
return NWNX_GetReturnValueInt(NWNX_Feedback, sFunc);
return NWNXPopInt();
}
void NWNX_Feedback_SetCombatLogMessageHidden(int nMessage, int isHidden, object oPC = OBJECT_INVALID)
{
string sFunc = "SetMessageHidden";
int nMessageType = 1;
NWNX_PushArgumentInt(NWNX_Feedback, sFunc, isHidden);
NWNX_PushArgumentInt(NWNX_Feedback, sFunc, nMessage);
NWNX_PushArgumentInt(NWNX_Feedback, sFunc, nMessageType);
NWNX_PushArgumentObject(NWNX_Feedback, sFunc, oPC);
NWNX_CallFunction(NWNX_Feedback, sFunc);
NWNXPushInt(isHidden);
NWNXPushInt(nMessage);
NWNXPushInt(1);
NWNXPushObject(oPC);
NWNXCall(NWNX_Feedback, "SetMessageHidden");
}
int NWNX_Feedback_GetJournalUpdatedMessageHidden(object oPC = OBJECT_INVALID)
{
string sFunc = "GetMessageHidden";
int nMessageType = 2;
NWNX_PushArgumentInt(NWNX_Feedback, sFunc, 0);
NWNX_PushArgumentInt(NWNX_Feedback, sFunc, nMessageType);
NWNX_PushArgumentObject(NWNX_Feedback, sFunc, oPC);
NWNX_CallFunction(NWNX_Feedback, sFunc);
return NWNX_GetReturnValueInt(NWNX_Feedback, sFunc);
NWNXPushInt(0);
NWNXPushInt(2);
NWNXPushObject(oPC);
NWNXCall(NWNX_Feedback, "GetMessageHidden");
return NWNXPopInt();
}
void NWNX_Feedback_SetJournalUpdatedMessageHidden(int isHidden, object oPC = OBJECT_INVALID)
{
string sFunc = "SetMessageHidden";
int nMessageType = 2;
NWNX_PushArgumentInt(NWNX_Feedback, sFunc, isHidden);
NWNX_PushArgumentInt(NWNX_Feedback, sFunc, 0);
NWNX_PushArgumentInt(NWNX_Feedback, sFunc, nMessageType);
NWNX_PushArgumentObject(NWNX_Feedback, sFunc, oPC);
NWNX_CallFunction(NWNX_Feedback, sFunc);
NWNXPushInt(isHidden);
NWNXPushInt(0);
NWNXPushInt(2);
NWNXPushObject(oPC);
NWNXCall(NWNX_Feedback, "SetMessageHidden");
}
void NWNX_Feedback_SetFeedbackMessageMode(int bWhitelist)
{
string sFunc = "SetFeedbackMode";
int nMessageType = 0;
NWNX_PushArgumentInt(NWNX_Feedback, sFunc, bWhitelist);
NWNX_PushArgumentInt(NWNX_Feedback, sFunc, nMessageType);
NWNX_CallFunction(NWNX_Feedback, sFunc);
NWNXPushInt(bWhitelist);
NWNXPushInt(0);
NWNXCall(NWNX_Feedback, "SetFeedbackMode");
}
void NWNX_Feedback_SetCombatLogMessageMode(int bWhitelist)
{
string sFunc = "SetFeedbackMode";
int nMessageType = 1;
NWNX_PushArgumentInt(NWNX_Feedback, sFunc, bWhitelist);
NWNX_PushArgumentInt(NWNX_Feedback, sFunc, nMessageType);
NWNX_CallFunction(NWNX_Feedback, sFunc);
NWNXPushInt(bWhitelist);
NWNXPushInt(1);
NWNXCall(NWNX_Feedback, "SetFeedbackMode");
}

View File

@@ -0,0 +1,107 @@
/// @addtogroup httpclient HTTPClient
/// @brief NWNX HTTPClient
/// @{
/// @file nwnx_httpclient.nss
const string NWNX_HTTPClient = "NWNX_HTTPClient"; ///< @private
/// @name Request Types
/// @anchor request_types
///
/// @{
const int NWNX_HTTPCLIENT_REQUEST_METHOD_GET = 0;
const int NWNX_HTTPCLIENT_REQUEST_METHOD_POST = 1;
const int NWNX_HTTPCLIENT_REQUEST_METHOD_DELETE = 2;
const int NWNX_HTTPCLIENT_REQUEST_METHOD_PATCH = 3;
const int NWNX_HTTPCLIENT_REQUEST_METHOD_PUT = 4;
const int NWNX_HTTPCLIENT_REQUEST_METHOD_OPTION = 5;
const int NWNX_HTTPCLIENT_REQUEST_METHOD_HEAD = 6;
///@}
/// @name Content Types
/// @anchor content_types
///
/// @{
const int NWNX_HTTPCLIENT_CONTENT_TYPE_HTML = 0;
const int NWNX_HTTPCLIENT_CONTENT_TYPE_PLAINTEXT = 1;
const int NWNX_HTTPCLIENT_CONTENT_TYPE_JSON = 2;
const int NWNX_HTTPCLIENT_CONTENT_TYPE_FORM_URLENCODED = 3;
const int NWNX_HTTPCLIENT_CONTENT_TYPE_XML = 4;
///@}
/// @name HTTP Authentication Types
/// @anchor auth_types
///
/// @{
const int NWNX_HTTPCLIENT_AUTH_TYPE_NONE = 0;
const int NWNX_HTTPCLIENT_AUTH_TYPE_BASIC = 1;
const int NWNX_HTTPCLIENT_AUTH_TYPE_DIGEST = 2;
const int NWNX_HTTPCLIENT_AUTH_TYPE_BEARER_TOKEN = 3;
///@}
/// A structure for an HTTP Client Request
struct NWNX_HTTPClient_Request
{
int nRequestMethod; ///< A @ref request_types "Request Type"
string sTag; ///< A unique tag for this request
string sHost; ///< The host domain name/IP address
string sPath; ///< The path for the url (include the leading /)
string sData; ///< The data being sent
int nContentType; ///< A @ref content_types "Content Type"
int nAuthType; ///< An @ref auth_types "Authentication Type"
string sAuthUserOrToken; ///< The authentication username or token
string sAuthPassword; ///< The authentication password (ignored if just using a token)
int nPort; ///< The host port
string sHeaders; ///< Pipe (|) delimited header pairs, e.g. "User-Agent: My NWNX HTTP Client|Accept: application/vnd.github.v3+json"
};
/// @brief Sends an http method to the given host.
/// @param s The structured NWNX_HTTPClient_Request information.
/// @return A unique identifier for the request for later access in the REQUEST_ID event data.
int NWNX_HTTPClient_SendRequest(struct NWNX_HTTPClient_Request s);
/// @brief Returns an NWNX_HTTP_Client_Request structure
/// @param nRequestId The request id returned from NWNX_HTTPClient_SendRequest()
/// @return The structured NWNX_HTTPClient_Request information
struct NWNX_HTTPClient_Request NWNX_HTTPClient_GetRequest(int nRequestId);
/// @}
int NWNX_HTTPClient_SendRequest(struct NWNX_HTTPClient_Request s)
{
NWNXPushString(s.sHeaders);
NWNXPushInt(s.nPort);
NWNXPushString(s.sAuthPassword);
NWNXPushString(s.sAuthUserOrToken);
NWNXPushInt(s.nAuthType);
NWNXPushString(s.sData);
NWNXPushInt(s.nContentType);
NWNXPushString(s.sPath);
NWNXPushString(s.sHost);
NWNXPushInt(s.nRequestMethod);
NWNXPushString(s.sTag);
NWNXCall(NWNX_HTTPClient, "SendRequest");
return NWNXPopInt();
}
struct NWNX_HTTPClient_Request NWNX_HTTPClient_GetRequest(int nRequestId)
{
NWNXPushInt(nRequestId);
NWNXCall(NWNX_HTTPClient, "GetRequest");
struct NWNX_HTTPClient_Request s;
s.sTag = NWNXPopString();
s.nRequestMethod = NWNXPopInt();
s.sHost = NWNXPopString();
s.sPath = NWNXPopString();
s.nContentType = NWNXPopInt();
s.sData = NWNXPopString();
s.nAuthType = NWNXPopInt();
s.sAuthUserOrToken = NWNXPopString();
s.sAuthPassword = NWNXPopString();
s.nPort = NWNXPopInt();
s.sHeaders = NWNXPopString();
return s;
}

View File

@@ -2,7 +2,6 @@
/// @brief Functions exposing additional item properties.
/// @{
/// @file nwnx_item.nss
#include "nwnx"
const string NWNX_Item = "NWNX_Item"; ///< @private
@@ -16,6 +15,7 @@ void NWNX_Item_SetWeight(object oItem, int weight);
/// @remark Total cost = base_value + additional_value.
/// @remark Equivalent to SetGoldPieceValue NWNX2 function.
/// @note Will not persist through saving.
/// @note This value will also revert if item is identified or player relogs into server.
/// @param oItem The item object.
/// @param gold The base gold value.
void NWNX_Item_SetBaseGoldPieceValue(object oItem, int gold);
@@ -68,7 +68,12 @@ void NWNX_Item_SetBaseItemType(object oItem, int nBaseItem);
///
/// [1] When specifying per-part coloring, the value 255 corresponds with the logical
/// function 'clear colour override', which clears the per-part override for that part.
void NWNX_Item_SetItemAppearance(object oItem, int nType, int nIndex, int nValue);
/// @param oItem The item
/// @param nType The type
/// @param nIndex The index
/// @param nValue The value
/// @param bUpdateCreatureAppearance If TRUE, also update the appearance of oItem's possessor. Only works for armor/helmets/cloaks. Will remove the item from the quickbar as side effect.
void NWNX_Item_SetItemAppearance(object oItem, int nType, int nIndex, int nValue, int bUpdateCreatureAppearance = FALSE);
/// @brief Return a string containing the entire appearance for an item.
/// @sa NWNX_Item_RestoreItemAppearance
@@ -91,117 +96,157 @@ int NWNX_Item_GetBaseArmorClass(object oItem);
/// @return The minimum level required to equip the item.
int NWNX_Item_GetMinEquipLevel(object oItem);
/// @brief Move oItem to oTarget
/// @remark Moving items from a container to the inventory of the container's owner (or the other way around) is always "silent" and won't trigger feedback messages
/// @param oItem The item object.
/// @param oTarget The target bag/creature/placeable or store object to move oItem to.
/// @param bHideAllFeedback Hides all feedback messages generated by losing/acquiring items
/// @return TRUE if the item was successfully moved to the target, otherwise FALSE
int NWNX_Item_MoveTo(object oItem, object oTarget, int bHideAllFeedback = FALSE);
/// @brief Set a modifier to the Minimum Level to Equip (Item Level Restriction).
/// @param oItem The item object.
/// @param nModifier the modifier to apply (After any Override)
/// @param bPersist Whether the modifier should persist to gff field. Strongly Recommended to be TRUE (See warning)
/// @note This function (or override partner) must be used each server reset to reenable persistence. Recommended use on OBJECT_INVALID OnModuleLoad.
/// @warning if Persistence is FALSE, or not renabled, beware characters may trigger ELC logging in with now-invalid ItemLevelRestrictions equipped.
void NWNX_Item_SetMinEquipLevelModifier(object oItem, int nModifier, int bPersist = TRUE);
/// @brief Gets the applied modifier to the Minimum Level to Equip (Item Level Restriction).
/// @param oItem The item object.
int NWNX_Item_GetMinEquipLevelModifier(object oItem);
/// @brief Set an override to the Minimum Level to Equip (Item Level Restriction).
/// @param oItem The item object.
/// @param nOverride the nOverride to apply (Before any Modifier)
/// @param bPersist Whether the modifier should persist to gff field. Strongly Recommended to be TRUE (See warning)
/// @note This function (or modifier partner) must be used each server reset to reenable persistence. Recommended use on OBJECT_INVALID OnModuleLoad.
/// @warning if Persistence is FALSE, or not renabled, beware characters may trigger ELC logging in with now-invalid ItemLevelRestrictions equipped.
void NWNX_Item_SetMinEquipLevelOverride(object oItem, int nOverride, int bPersist = TRUE);
/// @brief Gets the applied override to the Minimum Level to Equip (Item Level Restriction).
/// @param oItem The item object.
int NWNX_Item_GetMinEquipLevelOverride(object oItem);
/// @}
void NWNX_Item_SetWeight(object oItem, int w)
{
string sFunc = "SetWeight";
NWNX_PushArgumentInt(NWNX_Item, sFunc, w);
NWNX_PushArgumentObject(NWNX_Item, sFunc, oItem);
NWNX_CallFunction(NWNX_Item, sFunc);
NWNXPushInt(w);
NWNXPushObject(oItem);
NWNXCall(NWNX_Item, "SetWeight");
}
void NWNX_Item_SetBaseGoldPieceValue(object oItem, int g)
{
string sFunc = "SetBaseGoldPieceValue";
NWNX_PushArgumentInt(NWNX_Item, sFunc, g);
NWNX_PushArgumentObject(NWNX_Item, sFunc, oItem);
NWNX_CallFunction(NWNX_Item, sFunc);
NWNXPushInt(g);
NWNXPushObject(oItem);
NWNXCall(NWNX_Item, "SetBaseGoldPieceValue");
}
void NWNX_Item_SetAddGoldPieceValue(object oItem, int g)
{
string sFunc = "SetAddGoldPieceValue";
NWNX_PushArgumentInt(NWNX_Item, sFunc, g);
NWNX_PushArgumentObject(NWNX_Item, sFunc, oItem);
NWNX_CallFunction(NWNX_Item, sFunc);
NWNXPushInt(g);
NWNXPushObject(oItem);
NWNXCall(NWNX_Item, "SetAddGoldPieceValue");
}
int NWNX_Item_GetBaseGoldPieceValue(object oItem)
{
string sFunc = "GetBaseGoldPieceValue";
NWNX_PushArgumentObject(NWNX_Item, sFunc, oItem);
NWNX_CallFunction(NWNX_Item, sFunc);
return NWNX_GetReturnValueInt(NWNX_Item, sFunc);
NWNXPushObject(oItem);
NWNXCall(NWNX_Item, "GetBaseGoldPieceValue");
return NWNXPopInt();
}
int NWNX_Item_GetAddGoldPieceValue(object oItem)
{
string sFunc = "GetAddGoldPieceValue";
NWNX_PushArgumentObject(NWNX_Item, sFunc, oItem);
NWNX_CallFunction(NWNX_Item, sFunc);
return NWNX_GetReturnValueInt(NWNX_Item, sFunc);
NWNXPushObject(oItem);
NWNXCall(NWNX_Item, "GetAddGoldPieceValue");
return NWNXPopInt();
}
void NWNX_Item_SetBaseItemType(object oItem, int nBaseItem)
{
string sFunc = "SetBaseItemType";
NWNX_PushArgumentInt(NWNX_Item, sFunc, nBaseItem);
NWNX_PushArgumentObject(NWNX_Item, sFunc, oItem);
NWNX_CallFunction(NWNX_Item, sFunc);
NWNXPushInt(nBaseItem);
NWNXPushObject(oItem);
NWNXCall(NWNX_Item, "SetBaseItemType");
}
void NWNX_Item_SetItemAppearance(object oItem, int nType, int nIndex, int nValue)
void NWNX_Item_SetItemAppearance(object oItem, int nType, int nIndex, int nValue, int bUpdateCreatureAppearance = FALSE)
{
string sFunc = "SetItemAppearance";
NWNX_PushArgumentInt(NWNX_Item, sFunc, nValue);
NWNX_PushArgumentInt(NWNX_Item, sFunc, nIndex);
NWNX_PushArgumentInt(NWNX_Item, sFunc, nType);
NWNX_PushArgumentObject(NWNX_Item, sFunc, oItem);
NWNX_CallFunction(NWNX_Item, sFunc);
NWNXPushInt(bUpdateCreatureAppearance);
NWNXPushInt(nValue);
NWNXPushInt(nIndex);
NWNXPushInt(nType);
NWNXPushObject(oItem);
NWNXCall(NWNX_Item, "SetItemAppearance");
}
string NWNX_Item_GetEntireItemAppearance(object oItem)
{
string sFunc = "GetEntireItemAppearance";
NWNX_PushArgumentObject(NWNX_Item, sFunc, oItem);
NWNX_CallFunction(NWNX_Item, sFunc);
return NWNX_GetReturnValueString(NWNX_Item, sFunc);
NWNXPushObject(oItem);
NWNXCall(NWNX_Item, "GetEntireItemAppearance");
return NWNXPopString();
}
void NWNX_Item_RestoreItemAppearance(object oItem, string sApp)
{
string sFunc = "RestoreItemAppearance";
NWNX_PushArgumentString(NWNX_Item, sFunc, sApp);
NWNX_PushArgumentObject(NWNX_Item, sFunc, oItem);
NWNX_CallFunction(NWNX_Item, sFunc);
NWNXPushString(sApp);
NWNXPushObject(oItem);
NWNXCall(NWNX_Item, "RestoreItemAppearance");
}
int NWNX_Item_GetBaseArmorClass(object oItem)
{
string sFunc = "GetBaseArmorClass";
NWNX_PushArgumentObject(NWNX_Item, sFunc, oItem);
NWNX_CallFunction(NWNX_Item, sFunc);
return NWNX_GetReturnValueInt(NWNX_Item, sFunc);
NWNXPushObject(oItem);
NWNXCall(NWNX_Item, "GetBaseArmorClass");
return NWNXPopInt();
}
int NWNX_Item_GetMinEquipLevel(object oItem)
{
string sFunc = "GetMinEquipLevel";
NWNX_PushArgumentObject(NWNX_Item, sFunc, oItem);
NWNX_CallFunction(NWNX_Item, sFunc);
return NWNX_GetReturnValueInt(NWNX_Item, sFunc);
NWNXPushObject(oItem);
NWNXCall(NWNX_Item, "GetMinEquipLevel");
return NWNXPopInt();
}
int NWNX_Item_MoveTo(object oItem, object oTarget, int bHideAllFeedback = FALSE)
{
NWNXPushInt(bHideAllFeedback);
NWNXPushObject(oTarget);
NWNXPushObject(oItem);
NWNXCall(NWNX_Item, "MoveTo");
return NWNXPopInt();
}
void NWNX_Item_SetMinEquipLevelModifier(object oItem, int nModifier, int bPersist = TRUE)
{
NWNXPushInt(bPersist);
NWNXPushInt(nModifier);
NWNXPushObject(oItem);
NWNXCall(NWNX_Item, "SetMinEquipLevelModifier");
}
int NWNX_Item_GetMinEquipLevelModifier(object oItem)
{
NWNXPushObject(oItem);
NWNXCall(NWNX_Item, "GetMinEquipLevelModifier");
return NWNXPopInt();
}
void NWNX_Item_SetMinEquipLevelOverride(object oItem, int nOverride, int bPersist = TRUE)
{
NWNXPushInt(bPersist);
NWNXPushInt(nOverride);
NWNXPushObject(oItem);
NWNXCall(NWNX_Item, "SetMinEquipLevelOverride");
}
int NWNX_Item_GetMinEquipLevelOverride(object oItem)
{
NWNXPushObject(oItem);
NWNXCall(NWNX_Item, "GetMinEquipLevelOverride");
return NWNXPopInt();
}

View File

@@ -2,13 +2,13 @@
/// @brief Utility functions to manipulate the builtin itemproperty type.
/// @{
/// @file nwnx_itemprop.nss
#include "nwnx"
const string NWNX_ItemProperty = "NWNX_ItemProperty"; ///< @private
/// @brief An unpacked itemproperty.
struct NWNX_IPUnpacked
{
string sID; ///< @todo Describe
int nProperty; ///< @todo Describe
int nSubType; ///< @todo Describe
int nCostTable; ///< @todo Describe
@@ -33,49 +33,68 @@ struct NWNX_IPUnpacked NWNX_ItemProperty_UnpackIP(itemproperty ip);
/// @return The itemproperty.
itemproperty NWNX_ItemProperty_PackIP(struct NWNX_IPUnpacked ip);
/// @brief Gets the active item property at the index
/// @param oItem - the item with the property
/// @param nIndex - the index such as returned by some Item Events
/// @return A constructed NWNX_IPUnpacked, except for creator, and spell id.
struct NWNX_IPUnpacked NWNX_ItemProperty_GetActiveProperty(object oItem, int nIndex);
/// @}
struct NWNX_IPUnpacked NWNX_ItemProperty_UnpackIP(itemproperty ip)
{
string sFunc = "UnpackIP";
NWNX_PushArgumentItemProperty(NWNX_ItemProperty, sFunc, ip);
NWNX_CallFunction(NWNX_ItemProperty, sFunc);
NWNXPushItemProperty(ip);
NWNXCall(NWNX_ItemProperty, "UnpackIP");
struct NWNX_IPUnpacked n;
n.nProperty = NWNX_GetReturnValueInt(NWNX_ItemProperty, sFunc);
n.nSubType = NWNX_GetReturnValueInt(NWNX_ItemProperty, sFunc);
n.nCostTable = NWNX_GetReturnValueInt(NWNX_ItemProperty, sFunc);
n.nCostTableValue = NWNX_GetReturnValueInt(NWNX_ItemProperty, sFunc);
n.nParam1 = NWNX_GetReturnValueInt(NWNX_ItemProperty, sFunc);
n.nParam1Value = NWNX_GetReturnValueInt(NWNX_ItemProperty, sFunc);
n.nUsesPerDay = NWNX_GetReturnValueInt(NWNX_ItemProperty, sFunc);
n.nChanceToAppear = NWNX_GetReturnValueInt(NWNX_ItemProperty, sFunc);
n.bUsable = NWNX_GetReturnValueInt(NWNX_ItemProperty, sFunc);
n.nSpellId = NWNX_GetReturnValueInt(NWNX_ItemProperty, sFunc);
n.oCreator = NWNX_GetReturnValueObject(NWNX_ItemProperty, sFunc);
n.sTag = NWNX_GetReturnValueString(NWNX_ItemProperty, sFunc);
n.sID = NWNXPopString();
n.nProperty = NWNXPopInt();
n.nSubType = NWNXPopInt();
n.nCostTable = NWNXPopInt();
n.nCostTableValue = NWNXPopInt();
n.nParam1 = NWNXPopInt();
n.nParam1Value = NWNXPopInt();
n.nUsesPerDay = NWNXPopInt();
n.nChanceToAppear = NWNXPopInt();
n.bUsable = NWNXPopInt();
n.nSpellId = NWNXPopInt();
n.oCreator = NWNXPopObject();
n.sTag = NWNXPopString();
return n;
}
itemproperty NWNX_ItemProperty_PackIP(struct NWNX_IPUnpacked n)
{
string sFunc = "PackIP";
NWNX_PushArgumentString(NWNX_ItemProperty, sFunc, n.sTag);
NWNX_PushArgumentObject(NWNX_ItemProperty, sFunc, n.oCreator);
NWNX_PushArgumentInt(NWNX_ItemProperty, sFunc, n.nSpellId);
NWNX_PushArgumentInt(NWNX_ItemProperty, sFunc, n.bUsable);
NWNX_PushArgumentInt(NWNX_ItemProperty, sFunc, n.nChanceToAppear);
NWNX_PushArgumentInt(NWNX_ItemProperty, sFunc, n.nUsesPerDay);
NWNX_PushArgumentInt(NWNX_ItemProperty, sFunc, n.nParam1Value);
NWNX_PushArgumentInt(NWNX_ItemProperty, sFunc, n.nParam1);
NWNX_PushArgumentInt(NWNX_ItemProperty, sFunc, n.nCostTableValue);
NWNX_PushArgumentInt(NWNX_ItemProperty, sFunc, n.nCostTable);
NWNX_PushArgumentInt(NWNX_ItemProperty, sFunc, n.nSubType);
NWNX_PushArgumentInt(NWNX_ItemProperty, sFunc, n.nProperty);
NWNX_CallFunction(NWNX_ItemProperty, sFunc);
return NWNX_GetReturnValueItemProperty(NWNX_ItemProperty, sFunc);
NWNXPushString(n.sTag);
NWNXPushObject(n.oCreator);
NWNXPushInt(n.nSpellId);
NWNXPushInt(n.bUsable);
NWNXPushInt(n.nChanceToAppear);
NWNXPushInt(n.nUsesPerDay);
NWNXPushInt(n.nParam1Value);
NWNXPushInt(n.nParam1);
NWNXPushInt(n.nCostTableValue);
NWNXPushInt(n.nCostTable);
NWNXPushInt(n.nSubType);
NWNXPushInt(n.nProperty);
NWNXCall(NWNX_ItemProperty, "PackIP");
return NWNXPopItemProperty();
}
struct NWNX_IPUnpacked NWNX_ItemProperty_GetActiveProperty(object oItem, int nIndex)
{
NWNXPushInt(nIndex);
NWNXPushObject(oItem);
NWNXCall(NWNX_ItemProperty, "GetActiveProperty");
struct NWNX_IPUnpacked n;
n.nProperty = NWNXPopInt();
n.nSubType = NWNXPopInt();
n.nCostTable = NWNXPopInt();
n.nCostTableValue = NWNXPopInt();
n.nParam1 = NWNXPopInt();
n.nParam1Value = NWNXPopInt();
n.nUsesPerDay = NWNXPopInt();
n.nChanceToAppear = NWNXPopInt();
n.bUsable = NWNXPopInt();
n.sTag = NWNXPopString();
return n;
}

View File

@@ -2,7 +2,6 @@
/// @brief Execute Lua code and generate events in NWScript
/// @{
/// @file nwnx_lua.nss
#include "nwnx"
const string NWNX_Lua = "NWNX_Lua"; ///< @private
@@ -25,27 +24,21 @@ void NWNX_Lua_RunEvent(string sEvent, object oObject, string sExtra="");
void NWNX_Lua_EvalVoid(string sCode)
{
string sFunc = "EvalVoid";
NWNX_PushArgumentString(NWNX_Lua, sFunc, sCode);
NWNX_CallFunction(NWNX_Lua, sFunc);
NWNXPushString(sCode);
NWNXCall(NWNX_Lua, "EvalVoid");
}
string NWNX_Lua_Eval(string sCode)
{
string sFunc = "Eval";
NWNX_PushArgumentString(NWNX_Lua, sFunc, sCode);
NWNX_CallFunction(NWNX_Lua, sFunc);
return NWNX_GetReturnValueString(NWNX_Lua, sFunc);
NWNXPushString(sCode);
NWNXCall(NWNX_Lua, "Eval");
return NWNXPopString();
}
void NWNX_Lua_RunEvent(string sEvent, object oObject, string sExtra="")
{
string sFunc = "RunEvent";
NWNX_PushArgumentString(NWNX_Lua, sFunc, sExtra);
NWNX_PushArgumentObject(NWNX_Lua, sFunc, oObject);
NWNX_PushArgumentString(NWNX_Lua, sFunc, sEvent);
NWNX_CallFunction(NWNX_Lua, sFunc);
NWNXPushString(sExtra);
NWNXPushObject(oObject);
NWNXPushString(sEvent);
NWNXCall(NWNX_Lua, "RunEvent");
}

View File

@@ -0,0 +1,36 @@
/// @addtogroup nostack NoStack
/// @brief Functions to allow more control over ability/skill/bonuses stacking.
/// @{
/// @file nwnx_nostack.nss
const string NWNX_NoStack = "NWNX_NoStack"; ///< @private
/// @name Spell Effect Bonus Types
/// @anchor spell_bonus_types
///
/// Used with NWNX_NoStack_SetSpellBonusType() these are the effect bonus types.
/// @{
const int NWNX_NOSTACK_EFFECT_TYPE_ENHANCEMENT = 0;
const int NWNX_NOSTACK_EFFECT_TYPE_CIRCUMSTANCE = 1;
const int NWNX_NOSTACK_EFFECT_TYPE_COMPETENCE = 2;
const int NWNX_NOSTACK_EFFECT_TYPE_INSIGHT = 3;
const int NWNX_NOSTACK_EFFECT_TYPE_LUCK = 4;
const int NWNX_NOSTACK_EFFECT_TYPE_MORALE = 5;
const int NWNX_NOSTACK_EFFECT_TYPE_PROFANE = 6;
const int NWNX_NOSTACK_EFFECT_TYPE_RESISTANCE = 7;
const int NWNX_NOSTACK_EFFECT_TYPE_SACRED = 8;
/// @}
/// @brief Sets a spell bonus type to be used by the NoStack feature.
/// @param spell The spell ID from spells.2da.
/// @param type The new type.
void NWNX_NoStack_SetSpellBonusType(int spell, int type);
/// @}
void NWNX_NoStack_SetSpellBonusType(int spell, int type)
{
NWNXPushInt(type);
NWNXPushInt(spell);
NWNXCall(NWNX_NoStack, "SetSpellBonusType");
}

View File

@@ -0,0 +1,24 @@
/// @addtogroup nwsqliteextensions NWSQLiteExtensions
/// @brief Various extensions for the game's built-in sqlite database.
/// @{
/// @file nwnx_nwsqliteext.nss
const string NWNX_NWSQLiteExtensions = "NWNX_NWSQLiteExtensions"; ///< @private
/// @brief Create a virtual table for s2DA in the module sqlite database.
/// @param s2DA The 2DA name, cannot be empty.
/// @param sColumnTypeHints A string containing type hints for the 2DA columns. See this plugin's readme file for more info.
/// @param sTableName The table name, will use the 2da name if empty.
/// @return TRUE if the virtual table was created.
int NWNX_NWSQLiteExtensions_CreateVirtual2DATable(string s2DA, string sColumnTypeHints = "", string sTableName = "");
/// @}
int NWNX_NWSQLiteExtensions_CreateVirtual2DATable(string s2DA, string sColumnTypeHints = "", string sTableName = "")
{
NWNXPushString(sTableName);
NWNXPushString(sColumnTypeHints);
NWNXPushString(s2DA);
NWNXCall(NWNX_NWSQLiteExtensions, "CreateVirtual2DATable");
return NWNXPopInt();
}

File diff suppressed because it is too large Load Diff

View File

@@ -2,7 +2,6 @@
/// @brief Functions exposing additional player properties.
/// @{
/// @file nwnx_player.nss
#include "nwnx"
const string NWNX_Player = "NWNX_Player"; ///< @private
@@ -24,6 +23,22 @@ struct NWNX_Player_QuickBarSlot
object oAssociate; ///< @todo Describe
};
/// @brief A journal entry.
struct NWNX_Player_JournalEntry
{
string sName;///< @todo Describe
string sText;///< @todo Describe
string sTag;///< @todo Describe
int nState;///< @todo Describe
int nPriority;///< @todo Describe
int nQuestCompleted;///< @todo Describe
int nQuestDisplayed;///< @todo Describe
int nUpdated;///< @todo Describe
int nCalendarDay;///< @todo Describe
int nTimeOfDay;///< @todo Describe
};
/// @name Timing Bar Types
/// @anchor timing_bar_types
///
@@ -119,7 +134,10 @@ string NWNX_Player_GetBicFileName(object player);
/// @param player The player object.
/// @param effectId The effect id.
/// @param position The position to play the visual effect.
void NWNX_Player_ShowVisualEffect(object player, int effectId, vector position);
/// @param scale The scale of the effect
/// @param translate A translation vector to offset the position of the effect
/// @param rotate A rotation vector to rotate the effect
void NWNX_Player_ShowVisualEffect(object player, int effectId, vector position, float scale=1.0f, vector translate=[], vector rotate=[]);
/// @brief Changes the daytime music track for the given player only
/// @param player The player object.
@@ -174,8 +192,11 @@ void NWNX_Player_SetRestDuration(object player, int duration);
/// @param player The player object.
/// @param target The target object to play the effect upon.
/// @param visualeffect The visual effect id.
/// @param scale The scale of the effect
/// @param translate A translation vector to offset the position of the effect
/// @param rotate A rotation vector to rotate the effect
/// @note Only works with instant effects: VFX_COM_*, VFX_FNF_*, VFX_IMP_*
void NWNX_Player_ApplyInstantVisualEffectToObject(object player, object target, int visualeffect);
void NWNX_Player_ApplyInstantVisualEffectToObject(object player, object target, int visualeffect, float scale=1.0f, vector translate=[], vector rotate=[]);
/// @brief Refreshes the players character sheet
/// @param player The player object.
@@ -289,26 +310,163 @@ int NWNX_Player_GetLanguage(object oPlayer);
/// @param sNewResName The new res name or "" to clear a previous override, 16 characters or less.
void NWNX_Player_SetResManOverride(object oPlayer, int nResType, string sOldResName, string sNewResName);
/// @brief Set nCustomTokenNumber to sTokenValue for oPlayer only.
/// @note The basegame SetCustomToken() will override any personal tokens.
/// @param oPlayer The player object.
/// @param nCustomTokenNumber The token number.
/// @param sTokenValue The token text.
void NWNX_Player_SetCustomToken(object oPlayer, int nCustomTokenNumber, string sTokenValue);
/// @brief Override the name of creature for player only
/// @param oPlayer The player object.
/// @param oCreature The creature object.
/// @param sName The name for the creature for this player, "" to clear the override.
void NWNX_Player_SetCreatureNameOverride(object oPlayer, object oCreature, string sName);
/// @brief Display floaty text above oCreature for oPlayer only.
/// @note This will also display the floaty text above creatures that are not part of oPlayer's faction.
/// @param oPlayer The player to display the text to.
/// @param oCreature The creature to display the text above.
/// @param sText The text to display.
/// @param bChatWindow If TRUE, sText will be displayed in oPlayer's chat window.
void NWNX_Player_FloatingTextStringOnCreature(object oPlayer, object oCreature, string sText, int bChatWindow = TRUE);
/// @brief Toggle oPlayer's PlayerDM status.
/// @note This function does nothing for actual DMClient DMs or players with a client version < 8193.14
/// @param oPlayer The player.
/// @param bIsDM TRUE to toggle dm mode on, FALSE for off.
void NWNX_Player_ToggleDM(object oPlayer, int bIsDM);
/// @brief Override the mouse cursor of oObject for oPlayer only
/// @param oPlayer The player object.
/// @param oObject The object.
/// @param nCursor The cursor, one of MOUSECURSOR_*. -1 to clear the override.
void NWNX_Player_SetObjectMouseCursorOverride(object oPlayer, object oObject, int nCursor);
/// @brief Override the hilite color of oObject for oPlayer only
/// @param oPlayer The player object.
/// @param oObject The object.
/// @param nColor The color in 0xRRGGBB format, -1 to clear the override.
void NWNX_Player_SetObjectHiliteColorOverride(object oPlayer, object oObject, int nColor);
/// @brief Remove effects with sEffectTag from oPlayer's TURD
/// @note This function should be called in the NWNX_ON_CLIENT_DISCONNECT_AFTER event, OnClientLeave is too early for the TURD to exist.
/// @param oPlayer The player object.
/// @param sEffectTag The effect tag.
void NWNX_Player_RemoveEffectFromTURD(object oPlayer, string sEffectTag);
/// @brief Set the location oPlayer will spawn when logging in to the server.
/// @note This function is best called in the NWNX_ON_ELC_VALIDATE_CHARACTER_BEFORE event, OnClientEnter will be too late.
/// @param oPlayer The player object.
/// @param locSpawn The location.
void NWNX_Player_SetSpawnLocation(object oPlayer, location locSpawn);
/// @brief Resends palettes to a DM.
/// @param oPlayer - the DM to send them to.
void NWNX_Player_SendDMAllCreatorLists(object oPlayer);
/// @brief Give a custom journal entry to oPlayer.
/// @warning Custom entries are wiped on client enter - they must be reapplied.
/// @param oPlayer The player object.
/// @param journalEntry The journal entry in the form of a struct.
/// @param nSilentUpdate 0 = Notify player via sound effects and feedback message, 1 = Suppress sound effects and feedback message
/// @return a positive number to indicate the new amount of journal entries on the player.
/// @note In contrast to conventional nwn journal entries - this method will overwrite entries with the same tag, so the index / count of entries
/// will only increase if you add new entries with unique tags
int NWNX_Player_AddCustomJournalEntry(object oPlayer, struct NWNX_Player_JournalEntry journalEntry, int nSilentUpdate = 0);
/// @brief Returns a struct containing a journal entry that can then be modified.
/// @param oPlayer The player object.
/// @param questTag The quest tag you wish to get the journal entry for.
/// @return a struct containing the journal entry data.
/// @note This method will return -1 for the Updated field in the event that no matching journal entry was found,
/// only the last matching quest tag will be returned. Eg: If you add 3 journal updates to a player, only the 3rd one will be returned as
/// that is the active one that the player currently sees.
struct NWNX_Player_JournalEntry NWNX_Player_GetJournalEntry(object oPlayer, string questTag);
/// @brief Closes any store oPlayer may have open.
/// @param oPlayer The player object.
void NWNX_Player_CloseStore(object oPlayer);
/// @brief Override nStrRef from the TlkTable with sOverride for oPlayer only.
/// @param oPlayer The player.
/// @param nStrRef The StrRef.
/// @param sOverride The new value for nStrRef or "" to remove the override.
/// @param bRestoreGlobal If TRUE, when removing a personal override it will attempt to restore the global override if it exists.
/// @note Overrides will not persist through relogging.
void NWNX_Player_SetTlkOverride(object oPlayer, int nStrRef, string sOverride, int bRestoreGlobal = TRUE);
/// @brief Make the player reload it's TlkTable.
/// @param oPlayer The player.
void NWNX_Player_ReloadTlk(object oPlayer);
/// @brief Update wind for oPlayer only.
/// @param oPlayer The player.
/// @param vDirection The Wind's direction.
/// @param fMagnitude The Wind's magnitude.
/// @param fYaw The Wind's yaw.
/// @param fPitch The Wind's pitch.
void NWNX_Player_UpdateWind(object oPlayer, vector vDirection, float fMagnitude, float fYaw, float fPitch);
/// @brief Update the SkyBox for oPlayer only.
/// @param oPlayer The player.
/// @param nSkyBox The Skybox ID.
void NWNX_Player_UpdateSkyBox(object oPlayer, int nSkyBox);
/// @brief Update Sun and Moon Fog Color for oPlayer only.
/// @param oPlayer The player.
/// @param nSunFogColor The int value of Sun Fog color.
/// @param nMoonFogColor The int value of Moon Fog color.
void NWNX_Player_UpdateFogColor(object oPlayer, int nSunFogColor, int nMoonFogColor);
/// @brief Update Sun and Moon Fog Amount for oPlayer only.
/// @param oPlayer The player.
/// @param nSunFogAmount The int value of Sun Fog amount (range 0-255).
/// @param nMoonFogAmount The int value of Moon Fog amount (range 0-255).
void NWNX_Player_UpdateFogAmount(object oPlayer, int nSunFogAmount, int nMoonFogAmount);
/// @brief Return's the currently-possessed game object of a player.
/// @param oPlayer The player object (e.g. from GetFirst/NextPC()).
/// @return the actual game object of oPlayer, or OBJECT_INVALID on error.
object NWNX_Player_GetGameObject(object oPlayer);
/// @brief Override the ui discovery mask of oObject for oPlayer only
/// @param oPlayer The player object.
/// @param oObject The target object.
/// @param nMask A mask of OBJECT_UI_DISCOVERY_*, or -1 to clear the override
void NWNX_Player_SetObjectUiDiscoveryMaskOverride(object oPlayer, object oObject, int nMask);
/// @brief Send a party invite from oInviter to oPlayer
/// @param oPlayer The player to invite
/// @param oInviter The one inviting the player
/// @param bForceInvite TRUE: Sends the invite even if the target ignores invites
/// @param bHideDialog TRUE: Does not show the party invitation dialog
void NWNX_Player_SendPartyInvite(object oPlayer, object oInviter, int bForceInvite = FALSE, int bHideDialog = FALSE);
/// @brief Get the TURD for oPlayer
/// @param oPlayer The offline player to get the TURD from
/// @return the TURD object of oPlayer, or OBJECT_INVALID if no TURD exists
object NWNX_Player_GetTURD(object oPlayer);
/// @brief Reloads the color palettes for oPlayer
/// @param oPlayer The player to reload the color palette for
void NWNX_Player_ReloadColorPalettes(object oPlayer);
/// @}
void NWNX_Player_ForcePlaceableExamineWindow(object player, object placeable)
{
string sFunc = "ForcePlaceableExamineWindow";
NWNX_PushArgumentObject(NWNX_Player, sFunc, placeable);
NWNX_PushArgumentObject(NWNX_Player, sFunc, player);
NWNX_CallFunction(NWNX_Player, sFunc);
NWNXPushObject(placeable);
NWNXPushObject(player);
NWNXCall(NWNX_Player, "ForcePlaceableExamineWindow");
}
void NWNX_Player_ForcePlaceableInventoryWindow(object player, object placeable)
{
string sFunc = "ForcePlaceableInventoryWindow";
NWNX_PushArgumentObject(NWNX_Player, sFunc, placeable);
NWNX_PushArgumentObject(NWNX_Player, sFunc, player);
NWNX_CallFunction(NWNX_Player, sFunc);
NWNXPushObject(placeable);
NWNXPushObject(player);
NWNXCall(NWNX_Player, "ForcePlaceableInventoryWindow");
}
void NWNX_Player_INTERNAL_StopGuiTimingBar(object player, string script = "", int id = -1) ///< @private
@@ -317,17 +475,12 @@ void NWNX_Player_INTERNAL_StopGuiTimingBar(object player, string script = "", in
// Either the timing event was never started, or it already finished.
if (activeId == 0)
return;
// If id != -1, we ended up here through DelayCommand. Make sure it's for the right ID
if (id != -1 && id != activeId)
return;
DeleteLocalInt(player, "NWNX_PLAYER_GUI_TIMING_ACTIVE");
string sFunc = "StopGuiTimingBar";
NWNX_PushArgumentObject(NWNX_Player, sFunc, player);
NWNX_CallFunction(NWNX_Player, sFunc);
NWNXPushObject(player);
NWNXCall(NWNX_Player, "StopGuiTimingBar");
if(script != "")
{
ExecuteScript(script, player);
@@ -338,18 +491,13 @@ void NWNX_Player_StartGuiTimingBar(object player, float seconds, string script =
{
if (GetLocalInt(player, "NWNX_PLAYER_GUI_TIMING_ACTIVE"))
return;
string sFunc = "StartGuiTimingBar";
NWNX_PushArgumentInt(NWNX_Player, sFunc, type);
NWNX_PushArgumentFloat(NWNX_Player, sFunc, seconds);
NWNX_PushArgumentObject(NWNX_Player, sFunc, player);
NWNX_CallFunction(NWNX_Player, sFunc);
NWNXPushInt(type);
NWNXPushFloat(seconds);
NWNXPushObject(player);
NWNXCall(NWNX_Player, "StartGuiTimingBar");
int id = GetLocalInt(player, "NWNX_PLAYER_GUI_TIMING_ID") + 1;
SetLocalInt(player, "NWNX_PLAYER_GUI_TIMING_ACTIVE", id);
SetLocalInt(player, "NWNX_PLAYER_GUI_TIMING_ID", id);
DelayCommand(seconds, NWNX_Player_INTERNAL_StopGuiTimingBar(player, script, id));
}
@@ -360,360 +508,471 @@ void NWNX_Player_StopGuiTimingBar(object player, string script = "")
void NWNX_Player_SetAlwaysWalk(object player, int bWalk=TRUE)
{
string sFunc = "SetAlwaysWalk";
NWNX_PushArgumentInt(NWNX_Player, sFunc, bWalk);
NWNX_PushArgumentObject(NWNX_Player, sFunc, player);
NWNX_CallFunction(NWNX_Player, sFunc);
NWNXPushInt(bWalk);
NWNXPushObject(player);
NWNXCall(NWNX_Player, "SetAlwaysWalk");
}
struct NWNX_Player_QuickBarSlot NWNX_Player_GetQuickBarSlot(object player, int slot)
{
string sFunc = "GetQuickBarSlot";
struct NWNX_Player_QuickBarSlot qbs;
NWNX_PushArgumentInt(NWNX_Player, sFunc, slot);
NWNX_PushArgumentObject(NWNX_Player, sFunc, player);
NWNX_CallFunction(NWNX_Player, sFunc);
qbs.oAssociate = NWNX_GetReturnValueObject(NWNX_Player, sFunc);
qbs.nAssociateType = NWNX_GetReturnValueInt(NWNX_Player, sFunc);
qbs.nDomainLevel = NWNX_GetReturnValueInt(NWNX_Player, sFunc);
qbs.nMetaType = NWNX_GetReturnValueInt(NWNX_Player, sFunc);
qbs.nINTParam1 = NWNX_GetReturnValueInt(NWNX_Player, sFunc);
qbs.sToolTip = NWNX_GetReturnValueString(NWNX_Player, sFunc);
qbs.sCommandLine = NWNX_GetReturnValueString(NWNX_Player, sFunc);
qbs.sCommandLabel = NWNX_GetReturnValueString(NWNX_Player, sFunc);
qbs.sResRef = NWNX_GetReturnValueString(NWNX_Player, sFunc);
qbs.nMultiClass = NWNX_GetReturnValueInt(NWNX_Player, sFunc);
qbs.nObjectType = NWNX_GetReturnValueInt(NWNX_Player, sFunc);
qbs.oSecondaryItem = NWNX_GetReturnValueObject(NWNX_Player, sFunc);
qbs.oItem = NWNX_GetReturnValueObject(NWNX_Player, sFunc);
NWNXPushInt(slot);
NWNXPushObject(player);
NWNXCall(NWNX_Player, "GetQuickBarSlot");
qbs.oAssociate = NWNXPopObject();
qbs.nAssociateType = NWNXPopInt();
qbs.nDomainLevel = NWNXPopInt();
qbs.nMetaType = NWNXPopInt();
qbs.nINTParam1 = NWNXPopInt();
qbs.sToolTip = NWNXPopString();
qbs.sCommandLine = NWNXPopString();
qbs.sCommandLabel = NWNXPopString();
qbs.sResRef = NWNXPopString();
qbs.nMultiClass = NWNXPopInt();
qbs.nObjectType = NWNXPopInt();
qbs.oSecondaryItem = NWNXPopObject();
qbs.oItem = NWNXPopObject();
return qbs;
}
void NWNX_Player_SetQuickBarSlot(object player, int slot, struct NWNX_Player_QuickBarSlot qbs)
{
string sFunc = "SetQuickBarSlot";
NWNX_PushArgumentObject(NWNX_Player, sFunc, qbs.oItem);
NWNX_PushArgumentObject(NWNX_Player, sFunc, qbs.oSecondaryItem);
NWNX_PushArgumentInt(NWNX_Player, sFunc, qbs.nObjectType);
NWNX_PushArgumentInt(NWNX_Player, sFunc, qbs.nMultiClass);
NWNX_PushArgumentString(NWNX_Player, sFunc, qbs.sResRef);
NWNX_PushArgumentString(NWNX_Player, sFunc, qbs.sCommandLabel);
NWNX_PushArgumentString(NWNX_Player, sFunc, qbs.sCommandLine);
NWNX_PushArgumentString(NWNX_Player, sFunc, qbs.sToolTip);
NWNX_PushArgumentInt(NWNX_Player, sFunc, qbs.nINTParam1);
NWNX_PushArgumentInt(NWNX_Player, sFunc, qbs.nMetaType);
NWNX_PushArgumentInt(NWNX_Player, sFunc, qbs.nDomainLevel);
NWNX_PushArgumentInt(NWNX_Player, sFunc, qbs.nAssociateType);
NWNX_PushArgumentObject(NWNX_Player, sFunc, qbs.oAssociate);
NWNX_PushArgumentInt(NWNX_Player, sFunc, slot);
NWNX_PushArgumentObject(NWNX_Player, sFunc, player);
NWNX_CallFunction(NWNX_Player, sFunc);
NWNXPushObject(qbs.oItem);
NWNXPushObject(qbs.oSecondaryItem);
NWNXPushInt(qbs.nObjectType);
NWNXPushInt(qbs.nMultiClass);
NWNXPushString(qbs.sResRef);
NWNXPushString(qbs.sCommandLabel);
NWNXPushString(qbs.sCommandLine);
NWNXPushString(qbs.sToolTip);
NWNXPushInt(qbs.nINTParam1);
NWNXPushInt(qbs.nMetaType);
NWNXPushInt(qbs.nDomainLevel);
NWNXPushInt(qbs.nAssociateType);
NWNXPushObject(qbs.oAssociate);
NWNXPushInt(slot);
NWNXPushObject(player);
NWNXCall(NWNX_Player, "SetQuickBarSlot");
}
string NWNX_Player_GetBicFileName(object player)
{
string sFunc = "GetBicFileName";
NWNX_PushArgumentObject(NWNX_Player, sFunc, player);
NWNX_CallFunction(NWNX_Player, sFunc);
return NWNX_GetReturnValueString(NWNX_Player, sFunc);
NWNXPushObject(player);
NWNXCall(NWNX_Player, "GetBicFileName");
return NWNXPopString();
}
void NWNX_Player_ShowVisualEffect(object player, int effectId, vector position)
void NWNX_Player_ShowVisualEffect(object player, int effectId, vector position, float scale=1.0f, vector translate=[], vector rotate=[])
{
string sFunc = "ShowVisualEffect";
NWNX_PushArgumentFloat(NWNX_Player, sFunc, position.x);
NWNX_PushArgumentFloat(NWNX_Player, sFunc, position.y);
NWNX_PushArgumentFloat(NWNX_Player, sFunc, position.z);
NWNX_PushArgumentInt(NWNX_Player, sFunc, effectId);
NWNX_PushArgumentObject(NWNX_Player, sFunc, player);
NWNX_CallFunction(NWNX_Player, sFunc);
NWNXPushVector(rotate);
NWNXPushVector(translate);
NWNXPushFloat(scale);
NWNXPushVector(position);
NWNXPushInt(effectId);
NWNXPushObject(player);
NWNXCall(NWNX_Player, "ShowVisualEffect");
}
void NWNX_Player_MusicBackgroundChangeDay(object player, int track)
{
string sFunc = "ChangeBackgroundMusic";
NWNX_PushArgumentInt(NWNX_Player, sFunc, track);
NWNX_PushArgumentInt(NWNX_Player, sFunc, TRUE); // bool day = TRUE
NWNX_PushArgumentObject(NWNX_Player, sFunc, player);
NWNX_CallFunction(NWNX_Player, sFunc);
NWNXPushInt(track);
NWNXPushInt(TRUE);
NWNXPushObject(player);
NWNXCall(NWNX_Player, "ChangeBackgroundMusic");
}
void NWNX_Player_MusicBackgroundChangeNight(object player, int track)
{
string sFunc = "ChangeBackgroundMusic";
NWNX_PushArgumentInt(NWNX_Player, sFunc, track);
NWNX_PushArgumentInt(NWNX_Player, sFunc, FALSE); // bool day = FALSE
NWNX_PushArgumentObject(NWNX_Player, sFunc, player);
NWNX_CallFunction(NWNX_Player, sFunc);
NWNXPushInt(track);
NWNXPushInt(FALSE);
NWNXPushObject(player);
NWNXCall(NWNX_Player, "ChangeBackgroundMusic");
}
void NWNX_Player_MusicBackgroundStart(object player)
{
string sFunc = "PlayBackgroundMusic";
NWNX_PushArgumentInt(NWNX_Player, sFunc, TRUE); // bool play = TRUE
NWNX_PushArgumentObject(NWNX_Player, sFunc, player);
NWNX_CallFunction(NWNX_Player, sFunc);
NWNXPushInt(TRUE);
NWNXPushObject(player);
NWNXCall(NWNX_Player, "PlayBackgroundMusic");
}
void NWNX_Player_MusicBackgroundStop(object player)
{
string sFunc = "PlayBackgroundMusic";
NWNX_PushArgumentInt(NWNX_Player, sFunc, FALSE); // bool play = FALSE
NWNX_PushArgumentObject(NWNX_Player, sFunc, player);
NWNX_CallFunction(NWNX_Player, sFunc);
NWNXPushInt(FALSE);
NWNXPushObject(player);
NWNXCall(NWNX_Player, "PlayBackgroundMusic");
}
void NWNX_Player_MusicBattleChange(object player, int track)
{
string sFunc = "ChangeBattleMusic";
NWNX_PushArgumentInt(NWNX_Player, sFunc, track);
NWNX_PushArgumentObject(NWNX_Player, sFunc, player);
NWNX_CallFunction(NWNX_Player, sFunc);
NWNXPushInt(track);
NWNXPushObject(player);
NWNXCall(NWNX_Player, "ChangeBattleMusic");
}
void NWNX_Player_MusicBattleStart(object player)
{
string sFunc = "PlayBattleMusic";
NWNX_PushArgumentInt(NWNX_Player, sFunc, TRUE); // bool play = TRUE
NWNX_PushArgumentObject(NWNX_Player, sFunc, player);
NWNX_CallFunction(NWNX_Player, sFunc);
NWNXPushInt(TRUE);
NWNXPushObject(player);
NWNXCall(NWNX_Player, "PlayBattleMusic");
}
void NWNX_Player_MusicBattleStop(object player)
{
string sFunc = "PlayBattleMusic";
NWNX_PushArgumentInt(NWNX_Player, sFunc, FALSE); // bool play = FALSE
NWNX_PushArgumentObject(NWNX_Player, sFunc, player);
NWNX_CallFunction(NWNX_Player, sFunc);
NWNXPushInt(FALSE);
NWNXPushObject(player);
NWNXCall(NWNX_Player, "PlayBattleMusic");
}
void NWNX_Player_PlaySound(object player, string sound, object target = OBJECT_INVALID)
{
string sFunc = "PlaySound";
NWNX_PushArgumentObject(NWNX_Player, sFunc, target);
NWNX_PushArgumentString(NWNX_Player, sFunc, sound);
NWNX_PushArgumentObject(NWNX_Player, sFunc, player);
NWNX_CallFunction(NWNX_Player, sFunc);
NWNXPushObject(target);
NWNXPushString(sound);
NWNXPushObject(player);
NWNXCall(NWNX_Player, "PlaySound");
}
void NWNX_Player_SetPlaceableUsable(object player, object placeable, int usable)
{
string sFunc = "SetPlaceableUsable";
NWNX_PushArgumentInt(NWNX_Player, sFunc, usable);
NWNX_PushArgumentObject(NWNX_Player, sFunc, placeable);
NWNX_PushArgumentObject(NWNX_Player, sFunc, player);
NWNX_CallFunction(NWNX_Player, sFunc);
NWNXPushInt(usable);
NWNXPushObject(placeable);
NWNXPushObject(player);
NWNXCall(NWNX_Player, "SetPlaceableUsable");
}
void NWNX_Player_SetRestDuration(object player, int duration)
{
string sFunc = "SetRestDuration";
NWNX_PushArgumentInt(NWNX_Player, sFunc, duration);
NWNX_PushArgumentObject(NWNX_Player, sFunc, player);
NWNX_CallFunction(NWNX_Player, sFunc);
NWNXPushInt(duration);
NWNXPushObject(player);
NWNXCall(NWNX_Player, "SetRestDuration");
}
void NWNX_Player_ApplyInstantVisualEffectToObject(object player, object target, int visualeffect)
void NWNX_Player_ApplyInstantVisualEffectToObject(object player, object target, int visualeffect, float scale=1.0f, vector translate=[], vector rotate=[])
{
string sFunc = "ApplyInstantVisualEffectToObject";
NWNX_PushArgumentInt(NWNX_Player, sFunc, visualeffect);
NWNX_PushArgumentObject(NWNX_Player, sFunc, target);
NWNX_PushArgumentObject(NWNX_Player, sFunc, player);
NWNX_CallFunction(NWNX_Player, sFunc);
NWNXPushVector(rotate);
NWNXPushVector(translate);
NWNXPushFloat(scale);
NWNXPushInt(visualeffect);
NWNXPushObject(target);
NWNXPushObject(player);
NWNXCall(NWNX_Player, "ApplyInstantVisualEffectToObject");
}
void NWNX_Player_UpdateCharacterSheet(object player)
{
string sFunc = "UpdateCharacterSheet";
NWNX_PushArgumentObject(NWNX_Player, sFunc, player);
NWNX_CallFunction(NWNX_Player, sFunc);
NWNXPushObject(player);
NWNXCall(NWNX_Player, "UpdateCharacterSheet");
}
void NWNX_Player_OpenInventory(object player, object target, int open = TRUE)
{
string sFunc = "OpenInventory";
NWNX_PushArgumentInt(NWNX_Player, sFunc, open);
NWNX_PushArgumentObject(NWNX_Player, sFunc, target);
NWNX_PushArgumentObject(NWNX_Player, sFunc, player);
NWNX_CallFunction(NWNX_Player, sFunc);
NWNXPushInt(open);
NWNXPushObject(target);
NWNXPushObject(player);
NWNXCall(NWNX_Player, "OpenInventory");
}
string NWNX_Player_GetAreaExplorationState(object player, object area)
{
string sFunc = "GetAreaExplorationState";
NWNX_PushArgumentObject(NWNX_Player, sFunc, area);
NWNX_PushArgumentObject(NWNX_Player, sFunc, player);
NWNX_CallFunction(NWNX_Player, sFunc);
return NWNX_GetReturnValueString(NWNX_Player, sFunc);
NWNXPushObject(area);
NWNXPushObject(player);
NWNXCall(NWNX_Player, "GetAreaExplorationState");
return NWNXPopString();
}
void NWNX_Player_SetAreaExplorationState(object player, object area, string str)
{
string sFunc = "SetAreaExplorationState";
NWNX_PushArgumentString(NWNX_Player, sFunc, str);
NWNX_PushArgumentObject(NWNX_Player, sFunc, area);
NWNX_PushArgumentObject(NWNX_Player, sFunc, player);
NWNX_CallFunction(NWNX_Player, sFunc);
NWNXPushString(str);
NWNXPushObject(area);
NWNXPushObject(player);
NWNXCall(NWNX_Player, "SetAreaExplorationState");
}
void NWNX_Player_SetRestAnimation(object oPlayer, int nAnimation)
{
string sFunc = "SetRestAnimation";
NWNX_PushArgumentInt(NWNX_Player, sFunc, nAnimation);
NWNX_PushArgumentObject(NWNX_Player, sFunc, oPlayer);
NWNX_CallFunction(NWNX_Player, sFunc);
NWNXPushInt(nAnimation);
NWNXPushObject(oPlayer);
NWNXCall(NWNX_Player, "SetRestAnimation");
}
void NWNX_Player_SetObjectVisualTransformOverride(object oPlayer, object oObject, int nTransform, float fValue)
{
string sFunc = "SetObjectVisualTransformOverride";
NWNX_PushArgumentFloat(NWNX_Player, sFunc, fValue);
NWNX_PushArgumentInt(NWNX_Player, sFunc, nTransform);
NWNX_PushArgumentObject(NWNX_Player, sFunc, oObject);
NWNX_PushArgumentObject(NWNX_Player, sFunc, oPlayer);
NWNX_CallFunction(NWNX_Player, sFunc);
NWNXPushFloat(fValue);
NWNXPushInt(nTransform);
NWNXPushObject(oObject);
NWNXPushObject(oPlayer);
NWNXCall(NWNX_Player, "SetObjectVisualTransformOverride");
}
void NWNX_Player_ApplyLoopingVisualEffectToObject(object player, object target, int visualeffect)
{
string sFunc = "ApplyLoopingVisualEffectToObject";
NWNX_PushArgumentInt(NWNX_Player, sFunc, visualeffect);
NWNX_PushArgumentObject(NWNX_Player, sFunc, target);
NWNX_PushArgumentObject(NWNX_Player, sFunc, player);
NWNX_CallFunction(NWNX_Player, sFunc);
NWNXPushInt(visualeffect);
NWNXPushObject(target);
NWNXPushObject(player);
NWNXCall(NWNX_Player, "ApplyLoopingVisualEffectToObject");
}
void NWNX_Player_SetPlaceableNameOverride(object player, object placeable, string name)
{
string sFunc = "SetPlaceableNameOverride";
NWNX_PushArgumentString(NWNX_Player, sFunc, name);
NWNX_PushArgumentObject(NWNX_Player, sFunc, placeable);
NWNX_PushArgumentObject(NWNX_Player, sFunc, player);
NWNX_CallFunction(NWNX_Player, sFunc);
NWNXPushString(name);
NWNXPushObject(placeable);
NWNXPushObject(player);
NWNXCall(NWNX_Player, "SetPlaceableNameOverride");
}
int NWNX_Player_GetQuestCompleted(object player, string sQuestName)
{
string sFunc = "GetQuestCompleted";
NWNX_PushArgumentString(NWNX_Player, sFunc, sQuestName);
NWNX_PushArgumentObject(NWNX_Player, sFunc, player);
NWNX_CallFunction(NWNX_Player, sFunc);
return NWNX_GetReturnValueInt(NWNX_Player, sFunc);
NWNXPushString(sQuestName);
NWNXPushObject(player);
NWNXCall(NWNX_Player, "GetQuestCompleted");
return NWNXPopInt();
}
void NWNX_Player_SetPersistentLocation(string sCDKeyOrCommunityName, string sBicFileName, object oWP, int bFirstConnectOnly = TRUE)
{
string sFunc = "SetPersistentLocation";
NWNX_PushArgumentInt(NWNX_Player, sFunc, bFirstConnectOnly);
NWNX_PushArgumentObject(NWNX_Player, sFunc, oWP);
NWNX_PushArgumentString(NWNX_Player, sFunc, sBicFileName);
NWNX_PushArgumentString(NWNX_Player, sFunc, sCDKeyOrCommunityName);
NWNX_CallFunction(NWNX_Player, sFunc);
NWNXPushInt(bFirstConnectOnly);
NWNXPushObject(oWP);
NWNXPushString(sBicFileName);
NWNXPushString(sCDKeyOrCommunityName);
NWNXCall(NWNX_Player, "SetPersistentLocation");
}
void NWNX_Player_UpdateItemName(object oPlayer, object oItem)
{
string sFunc = "UpdateItemName";
NWNX_PushArgumentObject(NWNX_Player, sFunc, oItem);
NWNX_PushArgumentObject(NWNX_Player, sFunc, oPlayer);
NWNX_CallFunction(NWNX_Player, sFunc);
NWNXPushObject(oItem);
NWNXPushObject(oPlayer);
NWNXCall(NWNX_Player, "UpdateItemName");
}
int NWNX_Player_PossessCreature(object oPossessor, object oPossessed, int bMindImmune = TRUE, int bCreateDefaultQB = FALSE)
{
string sFunc = "PossessCreature";
NWNX_PushArgumentInt(NWNX_Player, sFunc, bCreateDefaultQB);
NWNX_PushArgumentInt(NWNX_Player, sFunc, bMindImmune);
NWNX_PushArgumentObject(NWNX_Player, sFunc, oPossessed);
NWNX_PushArgumentObject(NWNX_Player, sFunc, oPossessor);
NWNX_CallFunction(NWNX_Player, sFunc);
return NWNX_GetReturnValueInt(NWNX_Player, sFunc);
NWNXPushInt(bCreateDefaultQB);
NWNXPushInt(bMindImmune);
NWNXPushObject(oPossessed);
NWNXPushObject(oPossessor);
NWNXCall(NWNX_Player, "PossessCreature");
return NWNXPopInt();
}
int NWNX_Player_GetPlatformId(object oPlayer)
{
string sFunc = "GetPlatformId";
NWNX_PushArgumentObject(NWNX_Player, sFunc, oPlayer);
NWNX_CallFunction(NWNX_Player, sFunc);
return NWNX_GetReturnValueInt(NWNX_Player, sFunc);
NWNXPushObject(oPlayer);
NWNXCall(NWNX_Player, "GetPlatformId");
return NWNXPopInt();
}
int NWNX_Player_GetLanguage(object oPlayer)
{
string sFunc = "GetLanguage";
NWNX_PushArgumentObject(NWNX_Player, sFunc, oPlayer);
NWNX_CallFunction(NWNX_Player, sFunc);
return NWNX_GetReturnValueInt(NWNX_Player, sFunc);
NWNXPushObject(oPlayer);
NWNXCall(NWNX_Player, "GetLanguage");
return NWNXPopInt();
}
void NWNX_Player_SetResManOverride(object oPlayer, int nResType, string sOldResName, string sNewResName)
{
string sFunc = "SetResManOverride";
NWNX_PushArgumentString(NWNX_Player, sFunc, sNewResName);
NWNX_PushArgumentString(NWNX_Player, sFunc, sOldResName);
NWNX_PushArgumentInt(NWNX_Player, sFunc, nResType);
NWNX_PushArgumentObject(NWNX_Player, sFunc, oPlayer);
NWNX_CallFunction(NWNX_Player, sFunc);
NWNXPushString(sNewResName);
NWNXPushString(sOldResName);
NWNXPushInt(nResType);
NWNXPushObject(oPlayer);
NWNXCall(NWNX_Player, "SetResManOverride");
}
void NWNX_Player_SetCustomToken(object oPlayer, int nCustomTokenNumber, string sTokenValue)
{
NWNXPushString(sTokenValue);
NWNXPushInt(nCustomTokenNumber);
NWNXPushObject(oPlayer);
NWNXCall(NWNX_Player, "SetCustomToken");
}
void NWNX_Player_SetCreatureNameOverride(object oPlayer, object oCreature, string sName)
{
NWNXPushString(sName);
NWNXPushObject(oCreature);
NWNXPushObject(oPlayer);
NWNXCall(NWNX_Player, "SetCreatureNameOverride");
}
void NWNX_Player_FloatingTextStringOnCreature(object oPlayer, object oCreature, string sText, int bChatWindow = TRUE)
{
NWNXPushInt(bChatWindow);
NWNXPushString(sText);
NWNXPushObject(oCreature);
NWNXPushObject(oPlayer);
NWNXCall(NWNX_Player, "FloatingTextStringOnCreature");
}
void NWNX_Player_ToggleDM(object oPlayer, int bIsDM)
{
NWNXPushInt(bIsDM);
NWNXPushObject(oPlayer);
NWNXCall(NWNX_Player, "ToggleDM");
}
void NWNX_Player_SetObjectMouseCursorOverride(object oPlayer, object oObject, int nCursor)
{
NWNXPushInt(nCursor);
NWNXPushObject(oObject);
NWNXPushObject(oPlayer);
NWNXCall(NWNX_Player, "SetObjectMouseCursorOverride");
}
void NWNX_Player_SetObjectHiliteColorOverride(object oPlayer, object oObject, int nColor)
{
NWNXPushInt(nColor);
NWNXPushObject(oObject);
NWNXPushObject(oPlayer);
NWNXCall(NWNX_Player, "SetObjectHiliteColorOverride");
}
void NWNX_Player_RemoveEffectFromTURD(object oPlayer, string sEffectTag)
{
NWNXPushString(sEffectTag);
NWNXPushObject(oPlayer);
NWNXCall(NWNX_Player, "RemoveEffectFromTURD");
}
void NWNX_Player_SetSpawnLocation(object oPlayer, location locSpawn)
{
NWNXPushLocation(locSpawn);
NWNXPushObject(oPlayer);
NWNXCall(NWNX_Player, "SetSpawnLocation");
}
void NWNX_Player_SendDMAllCreatorLists(object oPlayer)
{
NWNXPushObject(oPlayer);
NWNXCall(NWNX_Player, "SendDMAllCreatorLists");
}
int NWNX_Player_AddCustomJournalEntry(object oPlayer, struct NWNX_Player_JournalEntry journalEntry, int nSilentUpdate = 0)
{
NWNXPushInt(nSilentUpdate);
NWNXPushInt(journalEntry.nTimeOfDay);
NWNXPushInt(journalEntry.nCalendarDay);
NWNXPushInt(journalEntry.nUpdated);
NWNXPushInt(journalEntry.nQuestDisplayed);
NWNXPushInt(journalEntry.nQuestCompleted);
NWNXPushInt(journalEntry.nPriority);
NWNXPushInt(journalEntry.nState);
NWNXPushString(journalEntry.sTag);
NWNXPushString(journalEntry.sText);
NWNXPushString(journalEntry.sName);
NWNXPushObject(oPlayer);
NWNXCall(NWNX_Player, "AddCustomJournalEntry");
return NWNXPopInt();
}
struct NWNX_Player_JournalEntry NWNX_Player_GetJournalEntry(object oPlayer, string questTag)
{
struct NWNX_Player_JournalEntry entry;
NWNXPushString(questTag);
NWNXPushObject(oPlayer);
NWNXCall(NWNX_Player, "GetJournalEntry");
entry.nUpdated = NWNXPopInt();
if(entry.nUpdated == -1) // -1 set as an indicator to say that the entry was not found
{
return entry;
}
entry.nQuestDisplayed = NWNXPopInt();
entry.nQuestCompleted = NWNXPopInt();
entry.nPriority = NWNXPopInt();
entry.nState = NWNXPopInt();
entry.nTimeOfDay = NWNXPopInt();
entry.nCalendarDay = NWNXPopInt();
entry.sName = NWNXPopString();
entry.sText = NWNXPopString();
entry.sTag = questTag;
return entry;
}
void NWNX_Player_CloseStore(object oPlayer)
{
NWNXPushObject(oPlayer);
NWNXCall(NWNX_Player, "CloseStore");
}
void NWNX_Player_SetTlkOverride(object oPlayer, int nStrRef, string sOverride, int bRestoreGlobal = TRUE)
{
NWNXPushInt(bRestoreGlobal);
NWNXPushString(sOverride);
NWNXPushInt(nStrRef);
NWNXPushObject(oPlayer);
NWNXCall(NWNX_Player, "SetTlkOverride");
}
void NWNX_Player_ReloadTlk(object oPlayer)
{
NWNXPushObject(oPlayer);
NWNXCall(NWNX_Player, "ReloadTlk");
}
void NWNX_Player_UpdateWind(object oPlayer, vector vDirection, float fMagnitude, float fYaw, float fPitch)
{
NWNXPushFloat(fPitch);
NWNXPushFloat(fYaw);
NWNXPushFloat(fMagnitude);
NWNXPushVector(vDirection);
NWNXPushObject(oPlayer);
NWNXCall(NWNX_Player, "UpdateWind");
}
void NWNX_Player_UpdateSkyBox(object oPlayer, int nSkyBox)
{
NWNXPushInt(nSkyBox);
NWNXPushObject(oPlayer);
NWNXCall(NWNX_Player, "UpdateSkyBox");
}
void NWNX_Player_UpdateFogColor(object oPlayer, int nSunFogColor, int nMoonFogColor)
{
NWNXPushInt(nMoonFogColor);
NWNXPushInt(nSunFogColor);
NWNXPushObject(oPlayer);
NWNXCall(NWNX_Player, "UpdateFogColor");
}
void NWNX_Player_UpdateFogAmount(object oPlayer, int nSunFogAmount, int nMoonFogAmount)
{
NWNXPushInt(nMoonFogAmount);
NWNXPushInt(nSunFogAmount);
NWNXPushObject(oPlayer);
NWNXCall(NWNX_Player, "UpdateFogAmount");
}
object NWNX_Player_GetGameObject(object oPlayer)
{
NWNXPushObject(oPlayer);
NWNXCall(NWNX_Player, "GetGameObject");
return NWNXPopObject();
}
void NWNX_Player_SetObjectUiDiscoveryMaskOverride(object oPlayer, object oObject, int nMask)
{
NWNXPushInt(nMask);
NWNXPushObject(oObject);
NWNXPushObject(oPlayer);
NWNXCall(NWNX_Player, "SetObjectUiDiscoveryMaskOverride");
}
void NWNX_Player_SendPartyInvite(object oPlayer, object oInviter, int bForceInvite = FALSE, int bHideDialog = FALSE)
{
NWNXPushInt(bHideDialog);
NWNXPushInt(bForceInvite);
NWNXPushObject(oInviter);
NWNXPushObject(oPlayer);
NWNXCall(NWNX_Player, "SendPartyInvite");
}
object NWNX_Player_GetTURD(object oPlayer)
{
NWNXPushObject(oPlayer);
NWNXCall(NWNX_Player, "GetTURD");
return NWNXPopObject();
}
void NWNX_Player_ReloadColorPalettes(object oPlayer)
{
NWNXPushObject(oPlayer);
NWNXCall(NWNX_Player, "ReloadColorPalettes");
}

View File

@@ -3,7 +3,6 @@
/// @remark These functions are for advanced users.
/// @{
/// @file nwnx_profiler.nss
#include "nwnx"
const string NWNX_Profiler = "NWNX_Profiler"; ///< @private
@@ -39,22 +38,17 @@ void NWNX_Profiler_PopPerfScope();
void NWNX_Profiler_PushPerfScope(string name, string tag0_tag = "", string tag0_value = "")
{
string sFunc = "PushPerfScope";
NWNX_PushArgumentString(NWNX_Profiler, sFunc, name);
if (tag0_value != "" && tag0_tag != "")
{
NWNX_PushArgumentString(NWNX_Profiler, sFunc, tag0_value);
NWNX_PushArgumentString(NWNX_Profiler, sFunc, tag0_tag);
NWNXPushString(tag0_value);
NWNXPushString(tag0_tag);
}
NWNX_CallFunction(NWNX_Profiler, sFunc);
NWNXPushString(name);
NWNXCall(NWNX_Profiler, "PushPerfScope");
}
void NWNX_Profiler_PopPerfScope()
{
string sFunc = "PopPerfScope";
NWNXCall(NWNX_Profiler, "PopPerfScope");
}
NWNX_CallFunction(NWNX_Profiler, sFunc);
}

View File

@@ -2,7 +2,6 @@
/// @brief Define racial and subrace characteristics.
/// @{
/// @file nwnx_race.nss
#include "nwnx"
const string NWNX_Race = "NWNX_Race"; ///< @private
@@ -46,27 +45,58 @@ void NWNX_Race_SetRacialModifier(int iRace, int iMod, int iParam1, int iParam2 =
/// @return The parent race if applicable, if not it just returns the race passed in.
int NWNX_Race_GetParentRace(int iRace);
/// @brief Associates the race with its favored enemy feat.
/// @param iRace The race
/// @param iFeat The feat
/// @note If a creature has a race that has a parent race then favored enemy bonuses will work for either race against that creature.
/// For example a creature is a Wild Elf which has a parent race of Elf, an attacker would benefit if they had either Favored Enemy: Elf
/// or Favored Enemy: Wild Elf
void NWNX_Race_SetFavoredEnemyFeat(int iRace, int iFeat);
/// @brief Removes any nwnx_race 'Effects' on the targeted creature. Suppression lasts until levelup, next login, or Reactivated by function.
/// @param oCreature The creature to suppress
/// @note Not all nwnx_race modifiers are achieved via effect. Those that are not directly consider the creatures current race.
void NWNX_Race_SuppressCreatureRaceEffects(object oCreature);
/// @brief Reactivates the nwnx_race 'Effects' on the targeted creature after they were Suppressed.
/// @param oCreature The creature to reactive
/// @note Safe to use on non-suppressed creatures - Triggers a refresh of effects but won't stack.
void NWNX_Race_ReactivateCreatureRaceEffects(object oCreature);
/// @}
void NWNX_Race_SetRacialModifier(int iRace, int iMod, int iParam1, int iParam2 = 0xDEADBEEF, int iParam3 = 0xDEADBEEF)
{
string sFunc = "SetRacialModifier";
NWNX_PushArgumentInt(NWNX_Race, sFunc, iParam3);
NWNX_PushArgumentInt(NWNX_Race, sFunc, iParam2);
NWNX_PushArgumentInt(NWNX_Race, sFunc, iParam1);
NWNX_PushArgumentInt(NWNX_Race, sFunc, iMod);
NWNX_PushArgumentInt(NWNX_Race, sFunc, iRace);
NWNX_CallFunction(NWNX_Race, sFunc);
NWNXPushInt(iParam3);
NWNXPushInt(iParam2);
NWNXPushInt(iParam1);
NWNXPushInt(iMod);
NWNXPushInt(iRace);
NWNXCall(NWNX_Race, "SetRacialModifier");
}
int NWNX_Race_GetParentRace(int iRace)
{
string sFunc = "GetParentRace";
NWNX_PushArgumentInt(NWNX_Race, sFunc, iRace);
NWNX_CallFunction(NWNX_Race, sFunc);
return NWNX_GetReturnValueInt(NWNX_Race, sFunc);
NWNXPushInt(iRace);
NWNXCall(NWNX_Race, "GetParentRace");
return NWNXPopInt();
}
void NWNX_Race_SetFavoredEnemyFeat(int iRace, int iFeat)
{
NWNXPushInt(iFeat);
NWNXPushInt(iRace);
NWNXCall(NWNX_Race, "SetFavoredEnemyFeat");
}
void NWNX_Race_SuppressCreatureRaceEffects(object creature)
{
NWNXPushObject(creature);
NWNXCall(NWNX_Race, "SuppressCreatureRaceEffects");
}
void NWNX_Race_ReactivateCreatureRaceEffects(object oCreature)
{
NWNXPushObject(oCreature);
NWNXCall(NWNX_Race, "ReactivateCreatureRaceEffects");
}

View File

@@ -2,7 +2,6 @@
/// @file nwnx_race_2da.nss
/// @brief Parse a column in the racialtypes.2da to load the modifiers.
#include "nwnx_race"
#include "nwnx_util"
/// @ingroup race
/// @brief Translate a modifier type from a string to its constant.
@@ -11,7 +10,7 @@
int NWNX_Race_GetModifierConstant(string raceMod);
/// @ingroup race
/// @brief Loops through racialtypes.2da and checks for a the column for racial modifications and sets them.
/// @brief Loops through racialtypes.2da and checks for the column for racial modifications and sets them.
/// @note Requires NWNX_Util_Get2DARowCount()
/// @param sColumnName The column name in the racialtypes.2da that defines the 2da for the racial mods.
void NWNX_Race_LoadRacialModifiers(string sColumnName = "RacialModsTable");
@@ -45,14 +44,14 @@ int NWNX_Race_GetModifierConstant(string raceMod)
void NWNX_Race_LoadRacialModifiers(string sColumnName = "RacialModsTable")
{
int iRaceRows = NWNX_Util_Get2DARowCount("racialtypes");
int iRaceRows = Get2DARowCount("racialtypes");
int iRace;
for (iRace = 0; iRace < iRaceRows; iRace++)
{
string sRaceModTable = Get2DAString("racialtypes", sColumnName, iRace);
if(sRaceModTable != "")
{
int iRaceModRows = NWNX_Util_Get2DARowCount(sRaceModTable);
int iRaceModRows = Get2DARowCount(sRaceModTable);
int iRaceMod;
for (iRaceMod = 0; iRaceMod < iRaceModRows; iRaceMod++)
{

File diff suppressed because it is too large Load Diff

View File

@@ -3,7 +3,6 @@
/// @{
/// @file nwnx_redis_lib.nss
/// @brief Allows connection and interfacing with a redis server.
#include "nwnx"
/// @anchor redis_results
/// @name Redis Results
@@ -65,44 +64,44 @@ string NWNX_Redis_GetResultAsString(int resultId);
int NWNX_Redis_GetResultType(int resultId)
{
NWNX_PushArgumentInt("NWNX_Redis", "GetResultType", resultId);
NWNX_CallFunction("NWNX_Redis", "GetResultType");
return NWNX_GetReturnValueInt("NWNX_Redis", "GetResultType");
NWNXPushInt(resultId);
NWNXCall("NWNX_Redis", "GetResultType");
return NWNXPopInt();
}
int NWNX_Redis_GetArrayLength(int resultId)
{
NWNX_PushArgumentInt("NWNX_Redis", "GetResultArrayLength", resultId);
NWNX_CallFunction("NWNX_Redis", "GetResultArrayLength");
return NWNX_GetReturnValueInt("NWNX_Redis", "GetResultArrayLength");
NWNXPushInt(resultId);
NWNXCall("NWNX_Redis", "GetResultArrayLength");
return NWNXPopInt();
}
// Returns the last
int NWNX_Redis_GetArrayElement(int resultId, int idx)
{
NWNX_PushArgumentInt("NWNX_Redis", "GetResultArrayElement", resultId);
NWNX_PushArgumentInt("NWNX_Redis", "GetResultArrayElement", idx);
NWNX_CallFunction("NWNX_Redis", "GetResultArrayElement");
return NWNX_GetReturnValueInt("NWNX_Redis", "GetResultArrayElement");
NWNXPushInt(resultId);
NWNXPushInt(idx);
NWNXCall("NWNX_Redis", "GetResultArrayElement");
return NWNXPopInt();
}
float NWNX_Redis_GetResultAsFloat(int resultId)
{
NWNX_PushArgumentInt("NWNX_Redis", "GetResultAsString", resultId);
NWNX_CallFunction("NWNX_Redis", "GetResultAsString");
return StringToFloat(NWNX_GetReturnValueString("NWNX_Redis", "GetResultAsString"));
NWNXPushInt(resultId);
NWNXCall("NWNX_Redis", "GetResultAsString");
return StringToFloat(NWNXPopString());
}
int NWNX_Redis_GetResultAsInt(int resultId)
{
NWNX_PushArgumentInt("NWNX_Redis", "GetResultAsString", resultId);
NWNX_CallFunction("NWNX_Redis", "GetResultAsString");
return StringToInt(NWNX_GetReturnValueString("NWNX_Redis", "GetResultAsString"));
NWNXPushInt(resultId);
NWNXCall("NWNX_Redis", "GetResultAsString");
return StringToInt(NWNXPopString());
}
string NWNX_Redis_GetResultAsString(int resultId)
{
NWNX_PushArgumentInt("NWNX_Redis", "GetResultAsString", resultId);
NWNX_CallFunction("NWNX_Redis", "GetResultAsString");
return NWNX_GetReturnValueString("NWNX_Redis", "GetResultAsString");
NWNXPushInt(resultId);
NWNXCall("NWNX_Redis", "GetResultAsString");
return NWNXPopString();
}

View File

@@ -2,7 +2,6 @@
/// @brief Interface to Redis PUBSUB
/// @{
/// @file nwnx_redis_ps.nss
#include "nwnx"
/// A redis PUBSUB message
struct NWNX_Redis_PubSubMessageData {
@@ -15,9 +14,9 @@ struct NWNX_Redis_PubSubMessageData {
struct NWNX_Redis_PubSubMessageData NWNX_Redis_GetPubSubMessageData()
{
struct NWNX_Redis_PubSubMessageData ret;
NWNX_CallFunction("NWNX_Redis", "GetPubSubData");
ret.message = NWNX_GetReturnValueString("NWNX_Redis", "GetPubSubData");
ret.channel = NWNX_GetReturnValueString("NWNX_Redis", "GetPubSubData");
NWNXCall("NWNX_Redis", "GetPubSubData");
ret.message = NWNXPopString();
ret.channel = NWNXPopString();
return ret;
}
/// @}

File diff suppressed because it is too large Load Diff

View File

@@ -2,7 +2,6 @@
/// @brief Facilitates renaming, overriding and customization of player names.
/// @{
/// @file nwnx_rename.nss
#include "nwnx"
const string NWNX_Rename = "NWNX_Rename"; ///< @private
@@ -46,35 +45,26 @@ void NWNX_Rename_ClearPCNameOverride(object oTarget, object oObserver = OBJECT_I
void NWNX_Rename_SetPCNameOverride(object oTarget, string sNewName, string sPrefix = "" , string sSuffix = "" ,
int iPlayerNameState = NWNX_RENAME_PLAYERNAME_DEFAULT, object oObserver = OBJECT_INVALID)
{
string sFunc = "SetPCNameOverride";
NWNX_PushArgumentObject(NWNX_Rename, sFunc, oObserver);
NWNX_PushArgumentInt(NWNX_Rename, sFunc, iPlayerNameState);
NWNX_PushArgumentString(NWNX_Rename, sFunc, sSuffix);
NWNX_PushArgumentString(NWNX_Rename, sFunc, sPrefix);
NWNX_PushArgumentString(NWNX_Rename, sFunc, sNewName);
NWNX_PushArgumentObject(NWNX_Rename, sFunc, oTarget);
NWNX_CallFunction(NWNX_Rename, sFunc);
NWNXPushObject(oObserver);
NWNXPushInt(iPlayerNameState);
NWNXPushString(sSuffix);
NWNXPushString(sPrefix);
NWNXPushString(sNewName);
NWNXPushObject(oTarget);
NWNXCall(NWNX_Rename, "SetPCNameOverride");
}
string NWNX_Rename_GetPCNameOverride(object oTarget, object oObserver = OBJECT_INVALID)
{
string sFunc = "GetPCNameOverride";
NWNX_PushArgumentObject(NWNX_Rename, sFunc, oObserver);
NWNX_PushArgumentObject(NWNX_Rename, sFunc, oTarget);
NWNX_CallFunction(NWNX_Rename, sFunc);
return NWNX_GetReturnValueString(NWNX_Rename, sFunc);
NWNXPushObject(oObserver);
NWNXPushObject(oTarget);
NWNXCall(NWNX_Rename, "GetPCNameOverride");
return NWNXPopString();
}
void NWNX_Rename_ClearPCNameOverride(object oTarget, object oObserver = OBJECT_INVALID, int clearAll = FALSE)
{
string sFunc = "ClearPCNameOverride";
NWNX_PushArgumentInt(NWNX_Rename, sFunc, clearAll);
NWNX_PushArgumentObject(NWNX_Rename, sFunc, oObserver);
NWNX_PushArgumentObject(NWNX_Rename, sFunc, oTarget);
NWNX_CallFunction(NWNX_Rename, sFunc);
NWNXPushInt(clearAll);
NWNXPushObject(oObserver);
NWNXPushObject(oTarget);
NWNXCall(NWNX_Rename, "ClearPCNameOverride");
}

View File

@@ -2,7 +2,6 @@
/// @brief Allows the selective revealing of a stealthing character to another character or their party.
/// @{
/// @file nwnx_reveal.nss
#include "nwnx"
const string NWNX_Reveal = "NWNX_Reveal"; ///< @private
@@ -28,22 +27,16 @@ void NWNX_Reveal_SetRevealToParty(object oHiding, int bReveal, int iDetectionMet
void NWNX_Reveal_RevealTo(object oHiding, object oObserver, int iDetectionMethod = NWNX_REVEAL_HEARD)
{
string sFunc = "RevealTo";
NWNX_PushArgumentInt(NWNX_Reveal, sFunc, iDetectionMethod);
NWNX_PushArgumentObject(NWNX_Reveal, sFunc, oObserver);
NWNX_PushArgumentObject(NWNX_Reveal, sFunc, oHiding);
NWNX_CallFunction(NWNX_Reveal, sFunc);
NWNXPushInt(iDetectionMethod);
NWNXPushObject(oObserver);
NWNXPushObject(oHiding);
NWNXCall(NWNX_Reveal, "RevealTo");
}
void NWNX_Reveal_SetRevealToParty(object oHiding, int bReveal, int iDetectionMethod = NWNX_REVEAL_HEARD)
{
string sFunc = "SetRevealToParty";
NWNX_PushArgumentInt(NWNX_Reveal, sFunc, iDetectionMethod);
NWNX_PushArgumentInt(NWNX_Reveal, sFunc, bReveal);
NWNX_PushArgumentObject(NWNX_Reveal, sFunc, oHiding);
NWNX_CallFunction(NWNX_Reveal, sFunc);
NWNXPushInt(iDetectionMethod);
NWNXPushInt(bReveal);
NWNXPushObject(oHiding);
NWNXCall(NWNX_Reveal, "SetRevealToParty");
}

View File

@@ -2,22 +2,19 @@
/// @brief Allows users to execute arbitrary Ruby from the game.
/// @{
/// @file nwnx_ruby.nss
#include "nwnx"
const string NWNX_Ruby = "NWNX_Ruby"; ///< @private
string NWNX_Ruby_Evaluate (string sCode);
string NWNX_Ruby_Evaluate(string sCode);
/// @brief Evaluates some ruby code.
/// @param sCode The code to evaluate.
/// @return The output of the call.
string NWNX_Ruby_Evaluate(string sCode)
{
string sFunc = "Evaluate";
NWNX_PushArgumentString (NWNX_Ruby, sFunc, sCode);
NWNX_CallFunction (NWNX_Ruby, sFunc);
return NWNX_GetReturnValueString (NWNX_Ruby, sFunc);
NWNXPushString(sCode);
NWNXCall(NWNX_Ruby, "Evaluate");
return NWNXPopString();
}
/// @}

View File

@@ -3,7 +3,6 @@
/// skill related feats as well as modifying stock feats.
/// @{
/// @file nwnx_skillranks.nss
#include "nwnx"
const string NWNX_SkillRanks = "NWNX_SkillRanks"; ///< @private
@@ -144,82 +143,67 @@ void NWNX_SkillRanks_SetAreaModifier(object oArea, int iSkill, int iModifier);
int NWNX_SkillRanks_GetSkillFeatCountForSkill(int iSkill)
{
string sFunc = "GetSkillFeatCountForSkill";
NWNX_PushArgumentInt(NWNX_SkillRanks, sFunc, iSkill);
NWNX_CallFunction(NWNX_SkillRanks, sFunc);
return NWNX_GetReturnValueInt(NWNX_SkillRanks, sFunc);
NWNXPushInt(iSkill);
NWNXCall(NWNX_SkillRanks, "GetSkillFeatCountForSkill");
return NWNXPopInt();
}
struct NWNX_SkillRanks_SkillFeat NWNX_SkillRanks_GetSkillFeatForSkillByIndex(int iSkill, int iIndex)
{
string sFunc = "GetSkillFeatForSkillByIndex";
NWNX_PushArgumentInt(NWNX_SkillRanks, sFunc, iIndex);
NWNX_PushArgumentInt(NWNX_SkillRanks, sFunc, iSkill);
NWNX_CallFunction(NWNX_SkillRanks, sFunc);
NWNXPushInt(iIndex);
NWNXPushInt(iSkill);
NWNXCall(NWNX_SkillRanks, "GetSkillFeatForSkillByIndex");
struct NWNX_SkillRanks_SkillFeat skillFeat;
skillFeat.iSkill = iSkill;
skillFeat.iFeat = NWNX_GetReturnValueInt(NWNX_SkillRanks, sFunc);
skillFeat.iModifier = NWNX_GetReturnValueInt(NWNX_SkillRanks, sFunc);
skillFeat.iFocusFeat = NWNX_GetReturnValueInt(NWNX_SkillRanks, sFunc);
skillFeat.sClasses = NWNX_GetReturnValueString(NWNX_SkillRanks, sFunc);
skillFeat.fClassLevelMod = NWNX_GetReturnValueFloat(NWNX_SkillRanks, sFunc);
skillFeat.iAreaFlagsRequired = NWNX_GetReturnValueInt(NWNX_SkillRanks, sFunc);
skillFeat.iAreaFlagsForbidden = NWNX_GetReturnValueInt(NWNX_SkillRanks, sFunc);
skillFeat.iDayOrNight = NWNX_GetReturnValueInt(NWNX_SkillRanks, sFunc);
skillFeat.bBypassArmorCheckPenalty = NWNX_GetReturnValueInt(NWNX_SkillRanks, sFunc);
skillFeat.iKeyAbilityMask = NWNX_GetReturnValueInt(NWNX_SkillRanks, sFunc);
skillFeat.iFeat = NWNXPopInt();
skillFeat.iModifier = NWNXPopInt();
skillFeat.iFocusFeat = NWNXPopInt();
skillFeat.sClasses = NWNXPopString();
skillFeat.fClassLevelMod = NWNXPopFloat();
skillFeat.iAreaFlagsRequired = NWNXPopInt();
skillFeat.iAreaFlagsForbidden = NWNXPopInt();
skillFeat.iDayOrNight = NWNXPopInt();
skillFeat.bBypassArmorCheckPenalty = NWNXPopInt();
skillFeat.iKeyAbilityMask = NWNXPopInt();
return skillFeat;
}
struct NWNX_SkillRanks_SkillFeat NWNX_SkillRanks_GetSkillFeat(int iSkill, int iFeat)
{
string sFunc = "GetSkillFeat";
NWNX_PushArgumentInt(NWNX_SkillRanks, sFunc, iFeat);
NWNX_PushArgumentInt(NWNX_SkillRanks, sFunc, iSkill);
NWNX_CallFunction(NWNX_SkillRanks, sFunc);
NWNXPushInt(iFeat);
NWNXPushInt(iSkill);
NWNXCall(NWNX_SkillRanks, "GetSkillFeat");
struct NWNX_SkillRanks_SkillFeat skillFeat;
skillFeat.iSkill = iSkill;
skillFeat.iFeat = iFeat;
skillFeat.iModifier = NWNX_GetReturnValueInt(NWNX_SkillRanks, sFunc);
skillFeat.iFocusFeat = NWNX_GetReturnValueInt(NWNX_SkillRanks, sFunc);
skillFeat.sClasses = NWNX_GetReturnValueString(NWNX_SkillRanks, sFunc);
skillFeat.fClassLevelMod = NWNX_GetReturnValueFloat(NWNX_SkillRanks, sFunc);
skillFeat.iAreaFlagsRequired = NWNX_GetReturnValueInt(NWNX_SkillRanks, sFunc);
skillFeat.iAreaFlagsForbidden = NWNX_GetReturnValueInt(NWNX_SkillRanks, sFunc);
skillFeat.iDayOrNight = NWNX_GetReturnValueInt(NWNX_SkillRanks, sFunc);
skillFeat.bBypassArmorCheckPenalty = NWNX_GetReturnValueInt(NWNX_SkillRanks, sFunc);
skillFeat.iKeyAbilityMask = NWNX_GetReturnValueInt(NWNX_SkillRanks, sFunc);
skillFeat.iModifier = NWNXPopInt();
skillFeat.iFocusFeat = NWNXPopInt();
skillFeat.sClasses = NWNXPopString();
skillFeat.fClassLevelMod = NWNXPopFloat();
skillFeat.iAreaFlagsRequired = NWNXPopInt();
skillFeat.iAreaFlagsForbidden = NWNXPopInt();
skillFeat.iDayOrNight = NWNXPopInt();
skillFeat.bBypassArmorCheckPenalty = NWNXPopInt();
skillFeat.iKeyAbilityMask = NWNXPopInt();
return skillFeat;
}
void NWNX_SkillRanks_SetSkillFeat(struct NWNX_SkillRanks_SkillFeat skillFeat, int createIfNonExistent = FALSE)
{
string sFunc = "SetSkillFeat";
NWNX_PushArgumentInt(NWNX_SkillRanks, sFunc, createIfNonExistent);
NWNX_PushArgumentInt(NWNX_SkillRanks, sFunc, skillFeat.iKeyAbilityMask);
NWNX_PushArgumentInt(NWNX_SkillRanks, sFunc, skillFeat.bBypassArmorCheckPenalty);
NWNX_PushArgumentInt(NWNX_SkillRanks, sFunc, skillFeat.iDayOrNight);
NWNX_PushArgumentInt(NWNX_SkillRanks, sFunc, skillFeat.iAreaFlagsForbidden);
NWNX_PushArgumentInt(NWNX_SkillRanks, sFunc, skillFeat.iAreaFlagsRequired);
NWNX_PushArgumentFloat(NWNX_SkillRanks, sFunc, skillFeat.fClassLevelMod);
NWNXPushInt(createIfNonExistent);
NWNXPushInt(skillFeat.iKeyAbilityMask);
NWNXPushInt(skillFeat.bBypassArmorCheckPenalty);
NWNXPushInt(skillFeat.iDayOrNight);
NWNXPushInt(skillFeat.iAreaFlagsForbidden);
NWNXPushInt(skillFeat.iAreaFlagsRequired);
NWNXPushFloat(skillFeat.fClassLevelMod);
// We only need to send the string from the point of the first set bit
NWNX_PushArgumentString(NWNX_SkillRanks, sFunc, GetStringRight(skillFeat.sClasses, GetStringLength(skillFeat.sClasses)-FindSubString(skillFeat.sClasses, "1")));
NWNX_PushArgumentInt(NWNX_SkillRanks, sFunc, skillFeat.iFocusFeat);
NWNX_PushArgumentInt(NWNX_SkillRanks, sFunc, skillFeat.iModifier);
NWNX_PushArgumentInt(NWNX_SkillRanks, sFunc, skillFeat.iFeat);
NWNX_PushArgumentInt(NWNX_SkillRanks, sFunc, skillFeat.iSkill);
NWNX_CallFunction(NWNX_SkillRanks, sFunc);
NWNXPushString(GetStringRight(skillFeat.sClasses,GetStringLength(skillFeat.sClasses)-FindSubString(skillFeat.sClasses,"1")));
NWNXPushInt(skillFeat.iFocusFeat);
NWNXPushInt(skillFeat.iModifier);
NWNXPushInt(skillFeat.iFeat);
NWNXPushInt(skillFeat.iSkill);
NWNXCall(NWNX_SkillRanks, "SetSkillFeat");
}
struct NWNX_SkillRanks_SkillFeat NWNX_SkillRanks_AddSkillFeatClass(struct NWNX_SkillRanks_SkillFeat skillFeat, int iClass)
@@ -237,47 +221,35 @@ struct NWNX_SkillRanks_SkillFeat NWNX_SkillRanks_AddSkillFeatClass(struct NWNX_S
void NWNX_SkillRanks_SetSkillFeatFocusModifier(int iModifier, int epicFocus = FALSE)
{
string sFunc = "SetSkillFeatFocusModifier";
NWNX_PushArgumentInt(NWNX_SkillRanks, sFunc, epicFocus);
NWNX_PushArgumentInt(NWNX_SkillRanks, sFunc, iModifier);
NWNX_CallFunction(NWNX_SkillRanks, sFunc);
NWNXPushInt(epicFocus);
NWNXPushInt(iModifier);
NWNXCall(NWNX_SkillRanks, "SetSkillFeatFocusModifier");
}
int NWNX_SkillRanks_GetBlindnessPenalty()
{
string sFunc = "GetBlindnessPenalty";
NWNX_CallFunction(NWNX_SkillRanks, sFunc);
return NWNX_GetReturnValueInt(NWNX_SkillRanks, sFunc);
NWNXCall(NWNX_SkillRanks, "GetBlindnessPenalty");
return NWNXPopInt();
}
void NWNX_SkillRanks_SetBlindnessPenalty(int iModifier)
{
string sFunc = "SetBlindnessPenalty";
NWNX_PushArgumentInt(NWNX_SkillRanks, sFunc, iModifier);
NWNX_CallFunction(NWNX_SkillRanks, sFunc);
NWNXPushInt(iModifier);
NWNXCall(NWNX_SkillRanks, "SetBlindnessPenalty");
}
int NWNX_SkillRanks_GetAreaModifier(object oArea, int iSkill)
{
string sFunc = "GetAreaModifier";
NWNX_PushArgumentInt(NWNX_SkillRanks, sFunc, iSkill);
NWNX_PushArgumentObject(NWNX_SkillRanks, sFunc, oArea);
NWNX_CallFunction(NWNX_SkillRanks, sFunc);
return NWNX_GetReturnValueInt(NWNX_SkillRanks, sFunc);
NWNXPushInt(iSkill);
NWNXPushObject(oArea);
NWNXCall(NWNX_SkillRanks, "GetAreaModifier");
return NWNXPopInt();
}
void NWNX_SkillRanks_SetAreaModifier(object oArea, int iSkill, int iModifier)
{
string sFunc = "SetAreaModifier";
NWNX_PushArgumentInt(NWNX_SkillRanks, sFunc, iModifier);
NWNX_PushArgumentInt(NWNX_SkillRanks, sFunc, iSkill);
NWNX_PushArgumentObject(NWNX_SkillRanks, sFunc, oArea);
NWNX_CallFunction(NWNX_SkillRanks, sFunc);
NWNXPushInt(iModifier);
NWNXPushInt(iSkill);
NWNXPushObject(oArea);
NWNXCall(NWNX_SkillRanks, "SetAreaModifier");
}

View File

@@ -2,7 +2,6 @@
/// @brief Functions related to spellchecking
/// @{
/// @file nwnx_spellcheck.nss
#include "nwnx"
const string NWNX_SpellChecker = "NWNX_SpellChecker"; ///< @private
@@ -27,17 +26,14 @@ string NWNX_SpellChecker_GetSuggestSpell(string word);
string NWNX_SpellChecker_FindMisspell(string sentence)
{
string sFunc = "FindMisspell";
NWNX_PushArgumentString(NWNX_SpellChecker, sFunc, sentence);
NWNX_CallFunction(NWNX_SpellChecker, sFunc);
return NWNX_GetReturnValueString(NWNX_SpellChecker, sFunc);
NWNXPushString(sentence);
NWNXCall(NWNX_SpellChecker, "FindMisspell");
return NWNXPopString();
}
string NWNX_SpellChecker_GetSuggestSpell(string word)
{
string sFunc = "GetSuggestSpell";
NWNX_PushArgumentString(NWNX_SpellChecker, sFunc, word);
NWNX_CallFunction(NWNX_SpellChecker, sFunc);
return NWNX_GetReturnValueString(NWNX_SpellChecker, sFunc);
NWNXPushString(word);
NWNXCall(NWNX_SpellChecker, "GetSuggestSpell");
return NWNXPopString();
}

View File

@@ -2,7 +2,6 @@
/// @brief Functions to interface with a database through SQL
/// @{
/// @file nwnx_sql.nss
#include "nwnx"
const string NWNX_SQL = "NWNX_SQL"; ///< @private
@@ -61,6 +60,16 @@ void NWNX_SQL_PreparedObjectId(int position, object value);
/// @param base64 Use base64-encoded string format if TRUE (default), otherwise use binary format.
void NWNX_SQL_PreparedObjectFull(int position, object value, int base64 = TRUE);
/// @brief Set the NULL value of a prepared statement at given position.
/// @param position The nth ? in a prepared statement.
void NWNX_SQL_PreparedNULL(int position);
/// @brief Set the Json value of a prepared statement at given position.
/// Convienence function to match other Prepared(type) functions.
/// @param position The nth ? in a prepared statement.
/// @param value The value to set.
void NWNX_SQL_PreparedJson(int position, json value);
/// @brief Like NWNX_SQL_ReadDataInActiveRow, but for full serialized objects.
///
/// The object will be deserialized and created in the game. New object ID is returned.
@@ -98,23 +107,23 @@ string NWNX_SQL_GetLastError();
/// @return Returns the number of parameters expected by the prepared query or -1 if no query is prepared.
int NWNX_SQL_GetPreparedQueryParamCount();
/// @brief Set the next query to return full binary results **ON THE FIRST COLUMN ONLY**.
/// @note This is ONLY needed on PostgreSQL, and ONLY if you want to deserialize raw bytea in NWNX_SQL_ReadFullObjectInActiveRow with base64=FALSE.
void NWNX_SQL_PostgreSQL_SetNextQueryResultsBinaryMode();
/// @}
int NWNX_SQL_PrepareQuery(string query)
{
string sFunc = "PrepareQuery";
NWNX_PushArgumentString(NWNX_SQL, sFunc, query);
NWNX_CallFunction(NWNX_SQL, sFunc);
return NWNX_GetReturnValueInt(NWNX_SQL, sFunc);
NWNXPushString(query);
NWNXCall(NWNX_SQL, "PrepareQuery");
return NWNXPopInt();
}
int NWNX_SQL_ExecutePreparedQuery()
{
string sFunc = "ExecutePreparedQuery";
NWNX_CallFunction(NWNX_SQL, sFunc);
return NWNX_GetReturnValueInt(NWNX_SQL, sFunc);
NWNXCall(NWNX_SQL, "ExecutePreparedQuery");
return NWNXPopInt();
}
int NWNX_SQL_ExecuteQuery(string query)
@@ -132,123 +141,109 @@ int NWNX_SQL_ExecuteQuery(string query)
int NWNX_SQL_ReadyToReadNextRow()
{
string sFunc = "ReadyToReadNextRow";
NWNX_CallFunction(NWNX_SQL, sFunc);
return NWNX_GetReturnValueInt(NWNX_SQL, sFunc);
NWNXCall(NWNX_SQL, "ReadyToReadNextRow");
return NWNXPopInt();
}
void NWNX_SQL_ReadNextRow()
{
string sFunc = "ReadNextRow";
NWNX_CallFunction(NWNX_SQL, sFunc);
NWNXCall(NWNX_SQL, "ReadNextRow");
}
string NWNX_SQL_ReadDataInActiveRow(int column = 0)
{
string sFunc = "ReadDataInActiveRow";
NWNX_PushArgumentInt(NWNX_SQL, sFunc, column);
NWNX_CallFunction(NWNX_SQL, sFunc);
return NWNX_GetReturnValueString(NWNX_SQL, sFunc);
NWNXPushInt(column);
NWNXCall(NWNX_SQL, "ReadDataInActiveRow");
return NWNXPopString();
}
void NWNX_SQL_PreparedInt(int position, int value)
{
string sFunc = "PreparedInt";
NWNX_PushArgumentInt(NWNX_SQL, sFunc, value);
NWNX_PushArgumentInt(NWNX_SQL, sFunc, position);
NWNX_CallFunction(NWNX_SQL, sFunc);
NWNXPushInt(value);
NWNXPushInt(position);
NWNXCall(NWNX_SQL, "PreparedInt");
}
void NWNX_SQL_PreparedString(int position, string value)
{
string sFunc = "PreparedString";
NWNX_PushArgumentString(NWNX_SQL, sFunc, value);
NWNX_PushArgumentInt(NWNX_SQL, sFunc, position);
NWNX_CallFunction(NWNX_SQL, sFunc);
NWNXPushString(value);
NWNXPushInt(position);
NWNXCall(NWNX_SQL, "PreparedString");
}
void NWNX_SQL_PreparedFloat(int position, float value)
{
string sFunc = "PreparedFloat";
NWNX_PushArgumentFloat(NWNX_SQL, sFunc, value);
NWNX_PushArgumentInt(NWNX_SQL, sFunc, position);
NWNX_CallFunction(NWNX_SQL, sFunc);
NWNXPushFloat(value);
NWNXPushInt(position);
NWNXCall(NWNX_SQL, "PreparedFloat");
}
void NWNX_SQL_PreparedObjectId(int position, object value)
{
string sFunc = "PreparedObjectId";
NWNX_PushArgumentObject(NWNX_SQL, sFunc, value);
NWNX_PushArgumentInt(NWNX_SQL, sFunc, position);
NWNX_CallFunction(NWNX_SQL, sFunc);
NWNXPushObject(value);
NWNXPushInt(position);
NWNXCall(NWNX_SQL, "PreparedObjectId");
}
void NWNX_SQL_PreparedObjectFull(int position, object value, int base64 = TRUE)
{
string sFunc = "PreparedObjectFull";
NWNX_PushArgumentInt(NWNX_SQL, sFunc, base64);
NWNX_PushArgumentObject(NWNX_SQL, sFunc, value);
NWNX_PushArgumentInt(NWNX_SQL, sFunc, position);
NWNX_CallFunction(NWNX_SQL, sFunc);
NWNXPushInt(base64);
NWNXPushObject(value);
NWNXPushInt(position);
NWNXCall(NWNX_SQL, "PreparedObjectFull");
}
void NWNX_SQL_PreparedNULL(int position)
{
NWNXPushInt(position);
NWNXCall(NWNX_SQL, "PreparedNULL");
}
void NWNX_SQL_PreparedJson(int position, json value)
{
// Dump to string and continue as a string from here.
// Famously assuming we're sent valid Json here.
NWNX_SQL_PreparedString(position, JsonDump(value));
}
object NWNX_SQL_ReadFullObjectInActiveRow(int column = 0, object owner = OBJECT_INVALID, float x = 0.0, float y = 0.0, float z = 0.0, int base64 = TRUE)
{
string sFunc = "ReadFullObjectInActiveRow";
NWNX_PushArgumentInt(NWNX_SQL, sFunc, base64);
NWNX_PushArgumentFloat(NWNX_SQL, sFunc, z);
NWNX_PushArgumentFloat(NWNX_SQL, sFunc, y);
NWNX_PushArgumentFloat(NWNX_SQL, sFunc, x);
NWNX_PushArgumentObject(NWNX_SQL, sFunc, owner);
NWNX_PushArgumentInt(NWNX_SQL, sFunc, column);
NWNX_CallFunction(NWNX_SQL, sFunc);
return NWNX_GetReturnValueObject(NWNX_SQL, sFunc);
NWNXPushInt(base64);
NWNXPushFloat(z);
NWNXPushFloat(y);
NWNXPushFloat(x);
NWNXPushObject(owner);
NWNXPushInt(column);
NWNXCall(NWNX_SQL, "ReadFullObjectInActiveRow");
return NWNXPopObject();
}
int NWNX_SQL_GetAffectedRows()
{
string sFunc = "GetAffectedRows";
NWNX_CallFunction(NWNX_SQL, sFunc);
return NWNX_GetReturnValueInt(NWNX_SQL, sFunc);
NWNXCall(NWNX_SQL, "GetAffectedRows");
return NWNXPopInt();
}
string NWNX_SQL_GetDatabaseType()
{
string sFunc = "GetDatabaseType";
NWNX_CallFunction(NWNX_SQL, sFunc);
return NWNX_GetReturnValueString(NWNX_SQL, sFunc);
NWNXCall(NWNX_SQL, "GetDatabaseType");
return NWNXPopString();
}
void NWNX_SQL_DestroyPreparedQuery()
{
string sFunc = "DestroyPreparedQuery";
NWNX_CallFunction(NWNX_SQL, sFunc);
NWNXCall(NWNX_SQL, "DestroyPreparedQuery");
}
string NWNX_SQL_GetLastError()
{
string sFunc = "GetLastError";
NWNX_CallFunction(NWNX_SQL, sFunc);
return NWNX_GetReturnValueString(NWNX_SQL, sFunc);
NWNXCall(NWNX_SQL, "GetLastError");
return NWNXPopString();
}
int NWNX_SQL_GetPreparedQueryParamCount()
{
string sFunc = "GetPreparedQueryParamCount";
NWNX_CallFunction(NWNX_SQL, sFunc);
return NWNX_GetReturnValueInt(NWNX_SQL, sFunc);
NWNXCall(NWNX_SQL, "GetPreparedQueryParamCount");
return NWNXPopInt();
}
void NWNX_SQL_PostgreSQL_SetNextQueryResultsBinaryMode()
{
NWNXCall(NWNX_SQL, "PostgreSQL_SetNextQueryResultsBinaryMode");
}

106
_module/nss/nwnx_store.nss Normal file
View File

@@ -0,0 +1,106 @@
/// @addtogroup store
/// @brief Functions exposing additional store properties.
/// @{
/// @file nwnx_store.nss
const string NWNX_Store = "NWNX_Store"; ///< @private
/// @brief Return status of a base item purchase status.
/// @param oStore The store object.
/// @param nBaseItem A BASE_ITEM_* value
/// @return TRUE if the quest has been completed. -1 if the player does not have the journal entry.
int NWNX_Store_GetIsRestrictedBuyItem(object oStore, int nBaseItem);
/// @brief Return the blackmarket mark down of a store
/// @param oStore The store object.
/// @return mark down of a store, -1 on error
int NWNX_Store_GetBlackMarketMarkDown(object oStore);
/// @brief Set the blackmarket mark down of a store
/// @param oStore The store object.
/// @param nValue The amount.
void NWNX_Store_SetBlackMarketMarkDown(object oStore, int nValue);
/// @brief Return the mark down of a store
/// @param oStore The store object.
/// @return mark down of a store, -1 on error
int NWNX_Store_GetMarkDown(object oStore);
/// @brief Set the mark down of a store
/// @param oStore The store object.
/// @param nValue The amount.
void NWNX_Store_SetMarkDown(object oStore, int nValue);
/// @brief Return the mark up of a store
/// @param oStore The store object.
/// @return mark up of a store, -1 on error
int NWNX_Store_GetMarkUp(object oStore);
/// @brief Set the mark up of a store
/// @param oStore The store object.
/// @param nValue The amount.
void NWNX_Store_SetMarkUp(object oStore, int nValue);
/// @brief Return current customer count
/// @param oStore The store object.
/// @return count, or -1 on error
int NWNX_Store_GetCurrentCustomersCount(object oStore);
/// @}
int NWNX_Store_GetIsRestrictedBuyItem(object oStore, int nBaseItem)
{
NWNXPushInt(nBaseItem);
NWNXPushObject(oStore);
NWNXCall(NWNX_Store, "GetIsRestrictedBuyItem");
return NWNXPopInt();
}
int NWNX_Store_GetBlackMarketMarkDown(object oStore)
{
NWNXPushObject(oStore);
NWNXCall(NWNX_Store, "GetBlackMarketMarkDown");
return NWNXPopInt();
}
void NWNX_Store_SetBlackMarketMarkDown(object oStore, int nValue)
{
NWNXPushInt(nValue);
NWNXPushObject(oStore);
NWNXCall(NWNX_Store, "SetBlackMarketMarkDown");
}
int NWNX_Store_GetMarkDown(object oStore)
{
NWNXPushObject(oStore);
NWNXCall(NWNX_Store, "GetMarkDown");
return NWNXPopInt();
}
void NWNX_Store_SetMarkDown(object oStore, int nValue)
{
NWNXPushInt(nValue);
NWNXPushObject(oStore);
NWNXCall(NWNX_Store, "SetMarkDown");
}
int NWNX_Store_GetMarkUp(object oStore)
{
NWNXPushObject(oStore);
NWNXCall(NWNX_Store, "GetMarkUp");
return NWNXPopInt();
}
void NWNX_Store_SetMarkUp(object oStore, int nValue)
{
NWNXPushInt(nValue);
NWNXPushObject(oStore);
NWNXCall(NWNX_Store, "SetMarkUp");
}
int NWNX_Store_GetCurrentCustomersCount(object oStore)
{
NWNXPushObject(oStore);
NWNXCall(NWNX_Store, "GetCurrentCustomersCount");
return NWNXPopInt();
}

View File

@@ -0,0 +1,324 @@
/// @addtogroup tileset Tileset
/// @brief An advanced plugin that exposes additional tileset and tile properties and allows builders to override the tiles of an area created with CreateArea().
/// @{
/// @file nwnx_tileset.nss
const string NWNX_Tileset = "NWNX_Tileset"; ///< @private
/// @brief A structure containing general tileset data.
struct NWNX_Tileset_TilesetData
{
int nNumTileData; ///< The number of tiles in the tileset.
float fHeightTransition; ///< The height difference between tiles on different heights.
int nNumTerrain; ///< The number of terrains in the tileset.
int nNumCrossers; ///< The number of crossers in the tileset.
int nNumGroups; ///< The number of groups in the tileset.
string sBorderTerrain; ///< The default border terrain of the tileset.
string sDefaultTerrain; ///< The default terrain of the tileset.
string sFloorTerrain; ///< The default floor terrain of the tileset.
int nDisplayNameStrRef; ///< The name of the tileset as strref, -1 if not set.
string sUnlocalizedName; ///< The unlocalized name of the tileset, "" if not set.
int bInterior; ///< The type of tileset. TRUE for interior, FALSE for exterior.
int bHasHeightTransition; ///< TRUE if the tileset supports multiple height levels. FALSE if not.
};
/// @brief A structure containing the group data for a tileset.
struct NWNX_Tileset_TilesetGroupData
{
string sName; ///< The name of the group.
int nStrRef; ///< The StrRef of the group.
int nRows; ///< The number of rows the group has.
int nColumns; ///< The number of columns the group has.
};
/// @brief A structure containing the edge and corner types of a tile.
struct NWNX_Tileset_TileEdgesAndCorners
{
string sTopLeft; ///< The top left corner.
string sTop; ///< The top edge.
string sTopRight; ///< The top right corner.
string sRight; ///< The right edge.
string sBottomRight; ///< The bottom right corner.
string sBottom; ///< The bottom edge.
string sBottomLeft; ///< The bottom left corner.
string sLeft; ///< The left edge.
};
/// @brief A structure containing the door data for a tile.
struct NWNX_Tileset_TileDoorData
{
int nType; ///< The type of door, returns an index into doortypes.2da.
float fX; ///< The X position of the door.
float fY; ///< The Y position of the door.
float fZ; ///< The Z position of the door.
float fOrientation; ///< The orientation of the door.
};
/// @brief A structure containing custom tile data,
struct NWNX_Tileset_CustomTileData
{
int nTileID; ///< The tile ID. See the tileset's .set file.
int nOrientation; ///< The orientation of the tile. Valid values: 0-3.
int nHeight; ///< The height of the tile.
int nMainLightColor1; ///< A `TILE_MAIN_LIGHT_COLOR_*` value.
int nMainLightColor2; ///< A `TILE_MAIN_LIGHT_COLOR_*` value.
int nSourceLightColor1; ///< A `TILE_SOURCE_LIGHT_COLOR_*` value.
int nSourceLightColor2; ///< A `TILE_SOURCE_LIGHT_COLOR_*` value.
int bAnimLoop1; ///< A bool to enable or disable the tile's first anim loop.
int bAnimLoop2; ///< A bool to enable or disable the tile's second anim loop.
int bAnimLoop3; ///< A bool to enable or disable the tile's third anim loop.
};
/// @brief Get general data of sTileset.
/// @param sTileset The tileset.
/// @return A NWNX_Tileset_TilesetData struct.
struct NWNX_Tileset_TilesetData NWNX_Tileset_GetTilesetData(string sTileset);
/// @brief Get the name of sTileset's terrain at nIndex.
/// @param sTileset The tileset.
/// @param nIndex The index of the terrain. Range: NWNX_Tileset_TilesetData.nNumTerrain > nIndex >= 0
/// @return The terrain name or "" on error.
string NWNX_Tileset_GetTilesetTerrain(string sTileset, int nIndex);
/// @brief Get the name of sTileset's crosser at nIndex.
/// @param sTileset The tileset.
/// @param nIndex The index of the crosser. Range: NWNX_Tileset_TilesetData.nNumCrossers > nIndex >= 0
/// @return The crosser name or "" on error.
string NWNX_Tileset_GetTilesetCrosser(string sTileset, int nIndex);
/// @brief Get general data of the group at nIndex in sTileset.
/// @param sTileset The tileset.
/// @param nIndex The index of the group. Range: NWNX_Tileset_TilesetData.nNumGroups > nIndex >= 0
/// @return A NWNX_Tileset_TilesetGroupData struct.
struct NWNX_Tileset_TilesetGroupData NWNX_Tileset_GetTilesetGroupData(string sTileset, int nIndex);
/// @brief Get the tile ID at nTileIndex in nGroupIndex of sTileset.
/// @param sTileset The tileset.
/// @param nGroupIndex The index of the group. Range: NWNX_Tileset_TilesetData.nNumGroups > nGroupIndex >= 0
/// @param nTileIndex The index of the tile. Range: (NWNX_Tileset_TilesetGroupData.nRows * NWNX_Tileset_TilesetGroupData.nColumns) > nTileIndex >= 0
/// @return The tile ID or 0 on error.
int NWNX_Tileset_GetTilesetGroupTile(string sTileset, int nGroupIndex, int nTileIndex);
/// @brief Get the model name of a tile in sTileset.
/// @param sTileset The tileset.
/// @param nTileID The tile ID.
/// @return The model name or "" on error.
string NWNX_Tileset_GetTileModel(string sTileset, int nTileID);
/// @brief Get the minimap texture name of a tile in sTileset.
/// @param sTileset The tileset.
/// @param nTileID The tile ID.
/// @return The minimap texture name or "" on error.
string NWNX_Tileset_GetTileMinimapTexture(string sTileset, int nTileID);
/// @brief Get the edges and corners of a tile in sTileset.
/// @param sTileset The tileset.
/// @param nTileID The tile ID.
/// @return A NWNX_Tileset_TileEdgesAndCorners struct.
struct NWNX_Tileset_TileEdgesAndCorners NWNX_Tileset_GetTileEdgesAndCorners(string sTileset, int nTileID);
/// @brief Get the number of doors of a tile in sTileset.
/// @param sTileset The tileset.
/// @param nTileID The tile ID.
/// @return The amount of doors.
int NWNX_Tileset_GetTileNumDoors(string sTileset, int nTileID);
/// @brief Get the door data of a tile in sTileset.
/// @param sTileset The tileset.
/// @param nTileID The tile ID.
/// @param nIndex The index of the door. Range: NWNX_Tileset_GetTileNumDoors() > nIndex >= 0
/// @return A NWNX_Tileset_TileDoorData struct.
struct NWNX_Tileset_TileDoorData NWNX_Tileset_GetTileDoorData(string sTileset, int nTileID, int nIndex = 0);
/// @brief Override the tiles of sAreaResRef with data in sOverrideName.
/// @param sAreaResRef The resref of the area to override.
/// @param sOverrideName The name of the override containing the custom tile data or "" to remove the override.
void NWNX_Tileset_SetAreaTileOverride(string sAreaResRef, string sOverrideName);
/// @brief Create a tile override named sOverrideName.
/// @param sOverrideName The name of the override.
/// @param sTileSet The tileset the override should use.
/// @param nWidth The width of the area. Valid values: 1-32.
/// @param nHeight The height of the area. Valid values: 1-32.
void NWNX_Tileset_CreateTileOverride(string sOverrideName, string sTileSet, int nWidth, int nHeight);
/// @brief Delete a tile override named sOverrideName.
/// @note This will also delete all custom tile data associated with sOverrideName.
/// @param sOverrideName The name of the override.
void NWNX_Tileset_DeleteTileOverride(string sOverrideName);
/// @brief Set custom tile data for the tile at nIndex in sOverrideName.
/// @note An override must first be created with NWNX_Tileset_CreateTileOverride().
/// @param sOverrideName The name of the override.
/// @param nIndex The index of the tile.
/// @param strCustomTileData A NWNX_Tileset_CustomTileData struct.
void NWNX_Tileset_SetOverrideTileData(string sOverrideName, int nIndex, struct NWNX_Tileset_CustomTileData strCustomTileData);
/// @brief Delete custom tile data of the tile at nIndex in sOverrideName.
/// @param sOverrideName The name of the override.
/// @param nIndex The tile's index or -1 to remove all custom tile data.
void NWNX_Tileset_DeleteOverrideTileData(string sOverrideName, int nIndex);
/// @}
struct NWNX_Tileset_TilesetData NWNX_Tileset_GetTilesetData(string sTileset)
{
NWNXPushString(sTileset);
NWNXCall(NWNX_Tileset, "GetTilesetData");
struct NWNX_Tileset_TilesetData str;
str.bHasHeightTransition = NWNXPopInt();
str.bInterior = NWNXPopInt();
str.sUnlocalizedName = NWNXPopString();
str.nDisplayNameStrRef = NWNXPopInt();
str.sFloorTerrain = NWNXPopString();
str.sDefaultTerrain = NWNXPopString();
str.sBorderTerrain = NWNXPopString();
str.nNumGroups = NWNXPopInt();
str.nNumCrossers = NWNXPopInt();
str.nNumTerrain = NWNXPopInt();
str.fHeightTransition = NWNXPopFloat();
str.nNumTileData = NWNXPopInt();
return str;
}
string NWNX_Tileset_GetTilesetTerrain(string sTileset, int nIndex)
{
NWNXPushInt(nIndex);
NWNXPushString(sTileset);
NWNXCall(NWNX_Tileset, "GetTilesetTerrain");
return NWNXPopString();
}
string NWNX_Tileset_GetTilesetCrosser(string sTileset, int nIndex)
{
NWNXPushInt(nIndex);
NWNXPushString(sTileset);
NWNXCall(NWNX_Tileset, "GetTilesetCrosser");
return NWNXPopString();
}
struct NWNX_Tileset_TilesetGroupData NWNX_Tileset_GetTilesetGroupData(string sTileset, int nIndex)
{
NWNXPushInt(nIndex);
NWNXPushString(sTileset);
NWNXCall(NWNX_Tileset, "GetTilesetGroupData");
struct NWNX_Tileset_TilesetGroupData str;
str.nColumns = NWNXPopInt();
str.nRows = NWNXPopInt();
str.nStrRef = NWNXPopInt();
str.sName = NWNXPopString();
return str;
}
int NWNX_Tileset_GetTilesetGroupTile(string sTileset, int nGroupIndex, int nTileIndex)
{
NWNXPushInt(nTileIndex);
NWNXPushInt(nGroupIndex);
NWNXPushString(sTileset);
NWNXCall(NWNX_Tileset, "GetTilesetGroupTile");
return NWNXPopInt();
}
string NWNX_Tileset_GetTileModel(string sTileset, int nTileID)
{
NWNXPushInt(nTileID);
NWNXPushString(sTileset);
NWNXCall(NWNX_Tileset, "GetTileModel");
return NWNXPopString();
}
string NWNX_Tileset_GetTileMinimapTexture(string sTileset, int nTileID)
{
NWNXPushInt(nTileID);
NWNXPushString(sTileset);
NWNXCall(NWNX_Tileset, "GetTileMinimapTexture");
return NWNXPopString();
}
struct NWNX_Tileset_TileEdgesAndCorners NWNX_Tileset_GetTileEdgesAndCorners(string sTileset, int nTileID)
{
NWNXPushInt(nTileID);
NWNXPushString(sTileset);
NWNXCall(NWNX_Tileset, "GetTileEdgesAndCorners");
struct NWNX_Tileset_TileEdgesAndCorners str;
str.sLeft = NWNXPopString();
str.sBottomLeft = NWNXPopString();
str.sBottom = NWNXPopString();
str.sBottomRight = NWNXPopString();
str.sRight = NWNXPopString();
str.sTopRight = NWNXPopString();
str.sTop = NWNXPopString();
str.sTopLeft = NWNXPopString();
return str;
}
int NWNX_Tileset_GetTileNumDoors(string sTileset, int nTileID)
{
NWNXPushInt(nTileID);
NWNXPushString(sTileset);
NWNXCall(NWNX_Tileset, "GetTileNumDoors");
return NWNXPopInt();
}
struct NWNX_Tileset_TileDoorData NWNX_Tileset_GetTileDoorData(string sTileset, int nTileID, int nIndex = 0)
{
NWNXPushInt(nIndex);
NWNXPushInt(nTileID);
NWNXPushString(sTileset);
NWNXCall(NWNX_Tileset, "GetTileDoorData");
struct NWNX_Tileset_TileDoorData str;
str.fOrientation = NWNXPopFloat();
str.fZ = NWNXPopFloat();
str.fY = NWNXPopFloat();
str.fX = NWNXPopFloat();
str.nType = NWNXPopInt();
return str;
}
void NWNX_Tileset_SetAreaTileOverride(string sAreaResRef, string sOverrideName)
{
NWNXPushString(sOverrideName);
NWNXPushString(sAreaResRef);
NWNXCall(NWNX_Tileset, "SetAreaTileOverride");
}
void NWNX_Tileset_CreateTileOverride(string sOverrideName, string sTileSet, int nWidth, int nHeight)
{
NWNXPushInt(nHeight);
NWNXPushInt(nWidth);
NWNXPushString(sTileSet);
NWNXPushString(sOverrideName);
NWNXCall(NWNX_Tileset, "CreateTileOverride");
}
void NWNX_Tileset_DeleteTileOverride(string sOverrideName)
{
NWNXPushString(sOverrideName);
NWNXCall(NWNX_Tileset, "DeleteTileOverride");
}
void NWNX_Tileset_SetOverrideTileData(string sOverrideName, int nIndex, struct NWNX_Tileset_CustomTileData strCustomTileData)
{
NWNXPushInt(strCustomTileData.bAnimLoop3);
NWNXPushInt(strCustomTileData.bAnimLoop2);
NWNXPushInt(strCustomTileData.bAnimLoop1);
NWNXPushInt(strCustomTileData.nSourceLightColor2);
NWNXPushInt(strCustomTileData.nSourceLightColor1);
NWNXPushInt(strCustomTileData.nMainLightColor2);
NWNXPushInt(strCustomTileData.nMainLightColor1);
NWNXPushInt(strCustomTileData.nHeight);
NWNXPushInt(strCustomTileData.nOrientation);
NWNXPushInt(strCustomTileData.nTileID);
NWNXPushInt(nIndex);
NWNXPushString(sOverrideName);
NWNXCall(NWNX_Tileset, "SetOverrideTileData");
}
void NWNX_Tileset_DeleteOverrideTileData(string sOverrideName, int nIndex)
{
NWNXPushInt(nIndex);
NWNXPushString(sOverrideName);
NWNXCall(NWNX_Tileset, "DeleteOverrideTileData");
}

View File

@@ -2,18 +2,22 @@
/// @brief Provides various time related functions
/// @{
/// @file nwnx_time.nss
#include "nwnx"
#include "nwnx_util"
#include "inc_sqlite_time"
const string NWNX_Time = "NWNX_Time"; ///< @private
/// @brief Returns the current date.
/// @deprecated Use SQLite functions (see inc_sqlite_time). This will be removed in future NWNX releases.
/// @return The date in the format (mm/dd/yyyy).
string NWNX_Time_GetSystemDate();
/// @brief Returns current time.
/// @deprecated Use SQLite functions (see inc_sqlite_time). This will be removed in future NWNX releases.
/// @return The current time in the format (24:mm:ss).
string NWNX_Time_GetSystemTime();
/// @deprecated Use SQLite functions (see inc_sqlite_time). This will be removed in future NWNX releases.
/// @return Returns the number of seconds since midnight on January 1, 1970.
int NWNX_Time_GetTimeStamp();
@@ -24,6 +28,7 @@ struct NWNX_Time_HighResTimestamp
int microseconds; ///< Microseconds
};
/// @deprecated Use NWNX_Util_GetHighResTimeStamp(). This will be removed in future NWNX releases.
/// @return Returns the number of microseconds since midnight on January 1, 1970.
struct NWNX_Time_HighResTimestamp NWNX_Time_GetHighResTimeStamp();
@@ -31,33 +36,28 @@ struct NWNX_Time_HighResTimestamp NWNX_Time_GetHighResTimeStamp();
string NWNX_Time_GetSystemDate()
{
string sFunc = "GetSystemDate";
NWNX_CallFunction(NWNX_Time, sFunc);
return NWNX_GetReturnValueString(NWNX_Time, sFunc);
WriteTimestampedLogEntry("WARNING: NWNX_Time is deprecated. You should migrate to SQLite based functions (see inc_sqlite_time).");
return SQLite_GetSystemDate();
}
string NWNX_Time_GetSystemTime()
{
string sFunc = "GetSystemTime";
NWNX_CallFunction(NWNX_Time, sFunc);
return NWNX_GetReturnValueString(NWNX_Time, sFunc);
WriteTimestampedLogEntry("WARNING: NWNX_Time is deprecated. You should migrate to SQLite based functions (see inc_sqlite_time).");
return SQLite_GetSystemTime();
}
int NWNX_Time_GetTimeStamp()
{
string sFunc = "GetTimeStamp";
NWNX_CallFunction(NWNX_Time, sFunc);
return NWNX_GetReturnValueInt(NWNX_Time, sFunc);
WriteTimestampedLogEntry("WARNING: NWNX_Time is deprecated. You should migrate to SQLite based functions (see inc_sqlite_time).");
return SQLite_GetTimeStamp();
}
struct NWNX_Time_HighResTimestamp NWNX_Time_GetHighResTimeStamp()
{
WriteTimestampedLogEntry("WARNING: NWNX_Time is deprecated. NWNX_Time_GetHighResTimeStamp is moving to NWNX_Util.");
struct NWNX_Util_HighResTimestamp u = NWNX_Util_GetHighResTimeStamp();
struct NWNX_Time_HighResTimestamp t;
string sFunc = "GetHighResTimeStamp";
NWNX_CallFunction(NWNX_Time, sFunc);
t.microseconds = NWNX_GetReturnValueInt(NWNX_Time, sFunc);
t.seconds = NWNX_GetReturnValueInt(NWNX_Time, sFunc);
t.seconds = u.seconds;
t.microseconds = u.microseconds;
return t;
}

View File

@@ -2,7 +2,6 @@
/// @brief Provides various utility functions that don't have a better home
/// @{
/// @file nwnx_util.nss
#include "nwnx"
const string NWNX_Util = "NWNX_Util"; ///< @private
@@ -28,6 +27,20 @@ const int NWNX_UTIL_RESREF_TYPE_STORE = 2051;
const int NWNX_UTIL_RESREF_TYPE_WAYPOINT = 2058;
///@}
/// @brief A world time struct
struct NWNX_Util_WorldTime
{
int nCalendarDay; ///< The calendar day
int nTimeOfDay; ///< The time of day
};
/// @brief A high resolution timestamp
struct NWNX_Util_HighResTimestamp
{
int seconds; ///< Seconds since epoch
int microseconds; ///< Microseconds
};
/// @brief Gets the name of the currently executing script.
/// @note If depth is > 0, it will return the name of the script that called this one via ExecuteScript().
/// @param depth to seek the executing script.
@@ -44,6 +57,14 @@ string NWNX_Util_GetAsciiTableString();
/// @return The hashed string as an integer.
int NWNX_Util_Hash(string str);
/// @brief Gets the last modified timestamp (mtime) of the module file in seconds.
/// @return The mtime of the module file.
int NWNX_Util_GetModuleMtime();
/// @brief Gets the module short file name.
/// @return The module file as a string.
string NWNX_Util_GetModuleFile();
/// @brief Gets the value of customTokenNumber.
/// @param customTokenNumber The token number to query.
/// @return The string representation of the token value.
@@ -54,7 +75,6 @@ string NWNX_Util_GetCustomToken(int customTokenNumber);
/// @return The converted itemproperty.
itemproperty NWNX_Util_EffectToItemProperty(effect e);
///
/// @brief Convert an itemproperty type to an effect type.
/// @param ip The itemproperty to convert to an effect.
/// @return The converted effect.
@@ -65,12 +85,6 @@ effect NWNX_Util_ItemPropertyToEffect(itemproperty ip);
/// @return The new string without any color codes.
string NWNX_Util_StripColors(string str);
/// @brief Determines if the supplied resref exists.
/// @param resref The resref to check.
/// @param type The @ref resref_types "Resref Type".
/// @return TRUE/FALSE
int NWNX_Util_IsValidResRef(string resref, int type = NWNX_UTIL_RESREF_TYPE_CREATURE);
/// @brief Retrieves an environment variable.
/// @param sVarname The environment variable to query.
/// @return The value of the environment variable.
@@ -90,12 +104,6 @@ void NWNX_Util_SetMinutesPerHour(int minutes);
/// @return The url encoded string.
string NWNX_Util_EncodeStringForURL(string str);
/// @anchor twoda_row_count
/// @brief Gets the row count for a 2da.
/// @param str The 2da to check (do not include the .2da).
/// @return The amount of rows in the 2da.
int NWNX_Util_Get2DARowCount(string str);
/// @brief Get the first resref of nType.
/// @param nType A @ref resref_types "Resref Type".
/// @param sRegexFilter Lets you filter out resrefs using a regexfilter.
@@ -109,11 +117,6 @@ string NWNX_Util_GetFirstResRef(int nType, string sRegexFilter = "", int bModule
/// @return The next resref found or "" if none is found.
string NWNX_Util_GetNextResRef();
/// @brief Get the ticks per second of the server.
/// @remark Useful to dynamically detect lag and adjust behavior accordingly.
/// @return The ticks per second.
int NWNX_Util_GetServerTicksPerSecond();
/// @brief Get the last created object.
/// @param nObjectType Does not take the NWScript OBJECT_TYPE_* constants.
/// Use NWNX_Consts_TranslateNWScriptObjectType() to get their NWNX equivalent.
@@ -121,37 +124,44 @@ int NWNX_Util_GetServerTicksPerSecond();
/// @return The last created object. On error, this returns OBJECT_INVALID.
object NWNX_Util_GetLastCreatedObject(int nObjectType, int nNthLast = 1);
/// @brief Compiles and adds a script to the UserDirectory/nwnx folder.
/// @brief Compiles and adds a script to the UserDirectory/nwnx folder, or to the location of sAlias.
/// @note Will override existing scripts that are in the module.
/// @param sFileName The script filename without extension, 16 or less characters.
/// @param sScriptData The script data to compile
/// @param bWrapIntoMain Set to TRUE to wrap sScriptData into void main(){}.
/// @param sAlias The alias of the resource directory to add the ncs file to. Default: UserDirectory/nwnx
/// @return "" on success, or the compilation error.
string NWNX_Util_AddScript(string sFileName, string sScriptData, int bWrapIntoMain = FALSE);
string NWNX_Util_AddScript(string sFileName, string sScriptData, int bWrapIntoMain = FALSE, string sAlias = "NWNX");
/// @brief Gets the contents of a .nss script file as a string.
/// @param sScriptName The name of the script to get the contents of.
/// @param nMaxLength The max length of the return string, -1 to get everything
/// @return The script file contents or "" on error.
string NWNX_Util_GetNSSContents(string sScriptName, int nMaxLength = -1);
/// @brief Adds a nss file to the UserDirectory/nwnx folder.
/// @brief Adds a nss file to the UserDirectory/nwnx folder, or to the location of sAlias.
/// @note Will override existing nss files that are in the module
/// @param sFileName The script filename without extension, 16 or less characters.
/// @param sContents The contents of the nss file
/// @param sAlias The alias of the resource directory to add the nss file to. Default: UserDirectory/nwnx
/// @return TRUE on success.
int NWNX_Util_AddNSSFile(string sFileName, string sContents);
int NWNX_Util_AddNSSFile(string sFileName, string sContents, string sAlias = "NWNX");
/// @brief Remove sFileName of nType from the UserDirectory/nwnx folder.
/// @brief Remove sFileName of nType from the UserDirectory/nwnx folder, or from the location of sAlias.
/// @param sFileName The filename without extension, 16 or less characters.
/// @param nType The @ref resref_types "Resref Type".
/// @param sAlias The alias of the resource directory to remove the file from. Default: UserDirectory/nwnx
/// @return TRUE on success.
int NWNX_Util_RemoveNWNXResourceFile(string sFileName, int nType);
int NWNX_Util_RemoveNWNXResourceFile(string sFileName, int nType, string sAlias = "NWNX");
/// @brief Set the NWScript instruction limit
/// @brief Set the NWScript instruction limit.
/// @param nInstructionLimit The new limit or -1 to reset to default.
void NWNX_Util_SetInstructionLimit(int nInstructionLimit);
/// @brief Get the NWScript instruction limit.
int NWNX_Util_GetInstructionLimit();
/// @brief Set the number of NWScript instructions currently executed.
/// @param nInstructions The number of instructions, must be >= 0.
void NWNX_Util_SetInstructionsExecuted(int nInstructions);
/// @brief Get the number of NWScript instructions currently executed.
int NWNX_Util_GetInstructionsExecuted();
/// @brief Register a server console command that will execute a script chunk.
/// @note Example usage: NWNX_Util_RegisterServerConsoleCommand("test", "PrintString(\"Test Command -> Args: $args\");");
/// @param sCommand The name of the command.
@@ -163,12 +173,6 @@ int NWNX_Util_RegisterServerConsoleCommand(string sCommand, string sScriptChunk)
/// @param sCommand The name of the command.
void NWNX_Util_UnregisterServerConsoleCommand(string sCommand);
/// @brief Determines if the given plugin exists and is enabled.
/// @param sPlugin The name of the plugin to check. This is the case sensitive plugin name as used by NWNX_CallFunction, NWNX_PushArgumentX
/// @note Example usage: NWNX_Util_PluginExists("NWNX_Creature");
/// @return TRUE if the plugin exists and is enabled, otherwise FALSE.
int NWNX_Util_PluginExists(string sPlugin);
/// @brief Gets the server's current working user folder.
/// @return The absolute path of the server's home directory (-userDirectory)
string NWNX_Util_GetUserDirectory();
@@ -177,245 +181,410 @@ string NWNX_Util_GetUserDirectory();
/// @return Return value of the last run script.
int NWNX_Util_GetScriptReturnValue();
/// @brief Create a door.
/// @param sResRef The ResRef of the door.
/// @param locLocation The location to create the door at.
/// @param sNewTag An optional new tag for the door.
/// @param nAppearanceType An optional index into doortypes.2da for appearance.
/// @return The door, or OBJECT_INVALID on failure.
object NWNX_Util_CreateDoor(string sResRef, location locLocation, string sNewTag = "", int nAppearanceType = -1);
/// @brief Set the object that will be returned by GetItemActivator.
/// @param oObject An object.
void NWNX_Util_SetItemActivator(object oObject);
/// @brief Get the world time as calendar day and time of day.
/// @note This function is useful for calculating effect expiry times.
/// @param fAdjustment An adjustment in seconds, 0.0f will return the current world time,
/// positive or negative values will return a world time in the future or past.
/// @return A NWNX_Util_WorldTime struct with the calendar day and time of day.
struct NWNX_Util_WorldTime NWNX_Util_GetWorldTime(float fAdjustment = 0.0f);
/// @brief Set a server-side resource override.
/// @param nResType A @ref resref_types "Resref Type".
/// @param sOldName The old resource name, 16 characters or less.
/// @param sNewName The new resource name or "" to clear a previous override, 16 characters or less.
void NWNX_Util_SetResourceOverride(int nResType, string sOldName, string sNewName);
/// @brief Get a server-side resource override.
/// @param nResType A @ref resref_types "Resref Type".
/// @param sName The name of the resource, 16 characters or less.
/// @return The resource override, or "" if one is not set.
string NWNX_Util_GetResourceOverride(int nResType, string sName);
/// @brief Get if a script param is set.
/// @param sParamName The script parameter name to check.
/// @return TRUE if the script param is set, FALSE if not or on error.
int NWNX_Util_GetScriptParamIsSet(string sParamName);
/// @brief Set the module dawn hour.
/// @param nDawnHour The new dawn hour
void NWNX_Util_SetDawnHour(int nDawnHour);
/// @brief Get the module dawn hour.
/// @return The dawn hour
int NWNX_Util_GetDawnHour();
/// @brief Set the module dusk hour.
/// @param nDuskHour The new dusk hour
void NWNX_Util_SetDuskHour(int nDuskHour);
/// @brief Get the module dusk hour.
/// @return The dusk hour
int NWNX_Util_GetDuskHour();
/// @return Returns the number of microseconds since midnight on January 1, 1970.
struct NWNX_Util_HighResTimestamp NWNX_Util_GetHighResTimeStamp();
/// @return Return name of a terminal, "" if not a TTY
string NWNX_Util_GetTTY();
/// @brief Set the currently running script event.
/// @param nEventID The ID of the event.
void NWNX_Util_SetCurrentlyRunningEvent(int nEventID);
/// @brief Calculate the levenshtein distance of two strings
/// @param sString The string to compare with.
/// @param sCompareTo The string to compare sString to.
/// @return The number of characters different between the compared strings.
int NWNX_Util_GetStringLevenshteinDistance(string sString, string sCompareTo);
/// @brief Sends a full object update of oObjectToUpdate to all clients
/// @param oObjectToUpdate The object to update
/// @param oPlayer The player for which the objects needs to update, OBJECT_INVALID for all players
void NWNX_Util_UpdateClientObject(object oObjectToUpdate, object oPlayer = OBJECT_INVALID);
/// @brief Clean a resource directory, deleting all files of nResType.
/// @param sAlias A resource directory alias, NWNX or one defined in the custom resource directory file.
/// @param nResType The type of file to delete or 0xFFFF for all types.
/// @return TRUE if successful, FALSE on error.
int NWNX_Util_CleanResourceDirectory(string sAlias, int nResType = 0xFFFF);
/// @brief Return the filename of the tlk file.
/// @return The name
string NWNX_Util_GetModuleTlkFile();
/// @brief Update a resource directory by having ResMan reindex it.
/// @param sAlias A resource directory alias, eg: TEMP
/// @return TRUE if successful, FALSE on error.
int NWNX_Util_UpdateResourceDirectory(string sAlias);
/// @}
string NWNX_Util_GetCurrentScriptName(int depth = 0)
{
string sFunc = "GetCurrentScriptName";
NWNX_PushArgumentInt(NWNX_Util, sFunc, depth);
NWNX_CallFunction(NWNX_Util, sFunc);
return NWNX_GetReturnValueString(NWNX_Util, sFunc);
NWNXPushInt(depth);
NWNXCall(NWNX_Util, "GetCurrentScriptName");
return NWNXPopString();
}
string NWNX_Util_GetAsciiTableString()
{
string sFunc = "GetAsciiTableString";
NWNX_CallFunction(NWNX_Util, sFunc);
return NWNX_GetReturnValueString(NWNX_Util, sFunc);
NWNXCall(NWNX_Util, "GetAsciiTableString");
return NWNXPopString();
}
int NWNX_Util_Hash(string str)
{
string sFunc = "Hash";
NWNX_PushArgumentString(NWNX_Util, sFunc, str);
NWNX_CallFunction(NWNX_Util, sFunc);
return NWNX_GetReturnValueInt(NWNX_Util, sFunc);
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)
{
string sFunc = "GetCustomToken";
NWNX_PushArgumentInt(NWNX_Util, sFunc, customTokenNumber);
NWNX_CallFunction(NWNX_Util, sFunc);
return NWNX_GetReturnValueString(NWNX_Util, sFunc);
NWNXPushInt(customTokenNumber);
NWNXCall(NWNX_Util, "GetCustomToken");
return NWNXPopString();
}
itemproperty NWNX_Util_EffectToItemProperty(effect e)
{
string sFunc = "EffectTypeCast";
NWNX_PushArgumentEffect(NWNX_Util, sFunc, e);
NWNX_CallFunction(NWNX_Util, sFunc);
return NWNX_GetReturnValueItemProperty(NWNX_Util, sFunc);
NWNXPushEffect(e);
NWNXCall(NWNX_Util, "EffectTypeCast");
return NWNXPopItemProperty();
}
effect NWNX_Util_ItemPropertyToEffect(itemproperty ip)
{
string sFunc = "EffectTypeCast";
NWNX_PushArgumentItemProperty(NWNX_Util, sFunc, ip);
NWNX_CallFunction(NWNX_Util, sFunc);
return NWNX_GetReturnValueEffect(NWNX_Util, sFunc);
NWNXPushItemProperty(ip);
NWNXCall(NWNX_Util, "EffectTypeCast");
return NWNXPopEffect();
}
string NWNX_Util_StripColors(string str)
{
string sFunc = "StripColors";
NWNX_PushArgumentString(NWNX_Util, sFunc, str);
NWNX_CallFunction(NWNX_Util, sFunc);
return NWNX_GetReturnValueString(NWNX_Util, sFunc);
}
int NWNX_Util_IsValidResRef(string resref, int type = NWNX_UTIL_RESREF_TYPE_CREATURE)
{
string sFunc = "IsValidResRef";
NWNX_PushArgumentInt(NWNX_Util, sFunc, type);
NWNX_PushArgumentString(NWNX_Util, sFunc, resref);
NWNX_CallFunction(NWNX_Util, sFunc);
return NWNX_GetReturnValueInt(NWNX_Util, sFunc);
NWNXPushString(str);
NWNXCall(NWNX_Util, "StripColors");
return NWNXPopString();
}
string NWNX_Util_GetEnvironmentVariable(string sVarname)
{
string sFunc = "GetEnvironmentVariable";
NWNX_PushArgumentString(NWNX_Util, sFunc, sVarname);
NWNX_CallFunction(NWNX_Util, sFunc);
return NWNX_GetReturnValueString(NWNX_Util, sFunc);
NWNXPushString(sVarname);
NWNXCall(NWNX_Util, "GetEnvironmentVariable");
return NWNXPopString();
}
int NWNX_Util_GetMinutesPerHour()
{
string sFunc = "GetMinutesPerHour";
NWNX_CallFunction(NWNX_Util, sFunc);
return NWNX_GetReturnValueInt(NWNX_Util, sFunc);
NWNXCall(NWNX_Util, "GetMinutesPerHour");
return NWNXPopInt();
}
void NWNX_Util_SetMinutesPerHour(int minutes)
{
string sFunc = "SetMinutesPerHour";
NWNX_PushArgumentInt(NWNX_Util, sFunc, minutes);
NWNX_CallFunction(NWNX_Util, sFunc);
NWNXPushInt(minutes);
NWNXCall(NWNX_Util, "SetMinutesPerHour");
}
string NWNX_Util_EncodeStringForURL(string sURL)
{
string sFunc = "EncodeStringForURL";
NWNX_PushArgumentString(NWNX_Util, sFunc, sURL);
NWNX_CallFunction(NWNX_Util, sFunc);
return NWNX_GetReturnValueString(NWNX_Util, sFunc);
}
int NWNX_Util_Get2DARowCount(string str)
{
string sFunc = "Get2DARowCount";
NWNX_PushArgumentString(NWNX_Util, sFunc, str);
NWNX_CallFunction(NWNX_Util, sFunc);
return NWNX_GetReturnValueInt(NWNX_Util, sFunc);
NWNXPushString(sURL);
NWNXCall(NWNX_Util, "EncodeStringForURL");
return NWNXPopString();
}
string NWNX_Util_GetFirstResRef(int nType, string sRegexFilter = "", int bModuleResourcesOnly = TRUE)
{
string sFunc = "GetFirstResRef";
NWNX_PushArgumentInt(NWNX_Util, sFunc, bModuleResourcesOnly);
NWNX_PushArgumentString(NWNX_Util, sFunc, sRegexFilter);
NWNX_PushArgumentInt(NWNX_Util, sFunc, nType);
NWNX_CallFunction(NWNX_Util, sFunc);
return NWNX_GetReturnValueString(NWNX_Util, sFunc);
NWNXPushInt(bModuleResourcesOnly);
NWNXPushString(sRegexFilter);
NWNXPushInt(nType);
NWNXCall(NWNX_Util, "GetFirstResRef");
return NWNXPopString();
}
string NWNX_Util_GetNextResRef()
{
string sFunc = "GetNextResRef";
NWNX_CallFunction(NWNX_Util, sFunc);
return NWNX_GetReturnValueString(NWNX_Util, sFunc);
}
int NWNX_Util_GetServerTicksPerSecond()
{
string sFunc = "GetServerTicksPerSecond";
NWNX_CallFunction(NWNX_Util, sFunc);
return NWNX_GetReturnValueInt(NWNX_Util, sFunc);
NWNXCall(NWNX_Util, "GetNextResRef");
return NWNXPopString();
}
object NWNX_Util_GetLastCreatedObject(int nObjectType, int nNthLast = 1)
{
string sFunc = "GetLastCreatedObject";
NWNX_PushArgumentInt(NWNX_Util, sFunc, nNthLast);
NWNX_PushArgumentInt(NWNX_Util, sFunc, nObjectType);
NWNX_CallFunction(NWNX_Util, sFunc);
return NWNX_GetReturnValueObject(NWNX_Util, sFunc);
NWNXPushInt(nNthLast);
NWNXPushInt(nObjectType);
NWNXCall(NWNX_Util, "GetLastCreatedObject");
return NWNXPopObject();
}
string NWNX_Util_AddScript(string sFileName, string sScriptData, int bWrapIntoMain = FALSE)
string NWNX_Util_AddScript(string sFileName, string sScriptData, int bWrapIntoMain = FALSE, string sAlias = "NWNX")
{
string sFunc = "AddScript";
NWNX_PushArgumentInt(NWNX_Util, sFunc, bWrapIntoMain);
NWNX_PushArgumentString(NWNX_Util, sFunc, sScriptData);
NWNX_PushArgumentString(NWNX_Util, sFunc, sFileName);
NWNX_CallFunction(NWNX_Util, sFunc);
return NWNX_GetReturnValueString(NWNX_Util, sFunc);
NWNXPushString(sAlias);
NWNXPushInt(bWrapIntoMain);
NWNXPushString(sScriptData);
NWNXPushString(sFileName);
NWNXCall(NWNX_Util, "AddScript");
return NWNXPopString();
}
string NWNX_Util_GetNSSContents(string sScriptName, int nMaxLength = -1)
int NWNX_Util_AddNSSFile(string sFileName, string sContents, string sAlias = "NWNX")
{
string sFunc = "GetNSSContents";
NWNX_PushArgumentInt(NWNX_Util, sFunc, nMaxLength);
NWNX_PushArgumentString(NWNX_Util, sFunc, sScriptName);
NWNX_CallFunction(NWNX_Util, sFunc);
return NWNX_GetReturnValueString(NWNX_Util, sFunc);
NWNXPushString(sAlias);
NWNXPushString(sContents);
NWNXPushString(sFileName);
NWNXCall(NWNX_Util, "AddNSSFile");
return NWNXPopInt();
}
int NWNX_Util_AddNSSFile(string sFileName, string sContents)
int NWNX_Util_RemoveNWNXResourceFile(string sFileName, int nType, string sAlias = "NWNX")
{
string sFunc = "AddNSSFile";
NWNX_PushArgumentString(NWNX_Util, sFunc, sContents);
NWNX_PushArgumentString(NWNX_Util, sFunc, sFileName);
NWNX_CallFunction(NWNX_Util, sFunc);
return NWNX_GetReturnValueInt(NWNX_Util, sFunc);
}
int NWNX_Util_RemoveNWNXResourceFile(string sFileName, int nType)
{
string sFunc = "RemoveNWNXResourceFile";
NWNX_PushArgumentInt(NWNX_Util, sFunc, nType);
NWNX_PushArgumentString(NWNX_Util, sFunc, sFileName);
NWNX_CallFunction(NWNX_Util, sFunc);
return NWNX_GetReturnValueInt(NWNX_Util, sFunc);
NWNXPushString(sAlias);
NWNXPushInt(nType);
NWNXPushString(sFileName);
NWNXCall(NWNX_Util, "RemoveNWNXResourceFile");
return NWNXPopInt();
}
void NWNX_Util_SetInstructionLimit(int nInstructionLimit)
{
string sFunc = "SetInstructionLimit";
NWNXPushInt(nInstructionLimit);
NWNXCall(NWNX_Util, "SetInstructionLimit");
}
NWNX_PushArgumentInt(NWNX_Util, sFunc, nInstructionLimit);
NWNX_CallFunction(NWNX_Util, sFunc);
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)
{
string sFunc = "RegisterServerConsoleCommand";
NWNX_PushArgumentString(NWNX_Util, sFunc, sScriptChunk);
NWNX_PushArgumentString(NWNX_Util, sFunc, sCommand);
NWNX_CallFunction(NWNX_Util, sFunc);
return NWNX_GetReturnValueInt(NWNX_Util, sFunc);
NWNXPushString(sScriptChunk);
NWNXPushString(sCommand);
NWNXCall(NWNX_Util, "RegisterServerConsoleCommand");
return NWNXPopInt();
}
void NWNX_Util_UnregisterServerConsoleCommand(string sCommand)
{
string sFunc = "UnregisterServerConsoleCommand";
NWNX_PushArgumentString(NWNX_Util, sFunc, sCommand);
NWNX_CallFunction(NWNX_Util, sFunc);
}
int NWNX_Util_PluginExists(string sPlugin)
{
string sFunc = "PluginExists";
NWNX_PushArgumentString(NWNX_Util, sFunc, sPlugin);
NWNX_CallFunction(NWNX_Util, sFunc);
return NWNX_GetReturnValueInt(NWNX_Util, sFunc);
NWNXPushString(sCommand);
NWNXCall(NWNX_Util, "UnregisterServerConsoleCommand");
}
string NWNX_Util_GetUserDirectory()
{
string sFunc = "GetUserDirectory";
NWNX_CallFunction(NWNX_Util, sFunc);
return NWNX_GetReturnValueString(NWNX_Util, sFunc);
NWNXCall(NWNX_Util, "GetUserDirectory");
return NWNXPopString();
}
int NWNX_Util_GetScriptReturnValue()
{
string sFunc = "GetScriptReturnValue";
NWNX_CallFunction(NWNX_Util, sFunc);
return NWNX_GetReturnValueInt(NWNX_Util, sFunc);
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();
}

View File

@@ -2,76 +2,70 @@
/// @brief Functions to manipulate visibility of objects both globally or per observer
/// @{
/// @file nwnx_visibility.nss
#include "nwnx"
const string NWNX_Visibility = "NWNX_Visibility"; ///< @private
/// @name Visibility Types
/// @anchor vis_types
/// @{
const int NWNX_VISIBILITY_DEFAULT = -1;
const int NWNX_VISIBILITY_VISIBLE = 0;
const int NWNX_VISIBILITY_HIDDEN = 1;
const int NWNX_VISIBILITY_DM_ONLY = 2;
const int NWNX_VISIBILITY_DEFAULT = -1;
const int NWNX_VISIBILITY_VISIBLE = 0;
const int NWNX_VISIBILITY_HIDDEN = 1;
const int NWNX_VISIBILITY_DM_ONLY = 2;
const int NWNX_VISIBILITY_ALWAYS_VISIBLE = 3;
const int NWNX_VISIBILITY_ALWAYS_VISIBLE_DM_ONLY = 4;
///@}
/// @brief Queries the existing visibility override for given (player, target) pair.
/// @brief Queries the existing visibility override for given (oPlayer, oTarget) pair.
/// If oPlayer is OBJECT_INVALID, the global visibility override will be returned.
///
/// If player is OBJECT_INVALID, the global visibility override will be returned
/// * Player == VALID -> returns:
/// * NWNX_VISIBILITY_DEFAULT = Player override not set
/// * NWNX_VISIBILITY_VISIBLE = Target is always visible for player
/// * NWNX_VISIBILITY_HIDDEN = Target is always hidden for player
/// * Player == OBJECT_INVALID -> returns:
/// * NWNX_VISIBILITY_DEFAULT = Global override not set
/// * NWNX_VISIBILITY_VISIBLE = Target is globally visible
/// * NWNX_VISIBILITY_HIDDEN = Target is globally hidden
/// * NWNX_VISIBILITY_DM_ONLY = Target is only visible to DMs
/// @param player The PC Object or OBJECT_INVALID.
/// @param target The object for which we're querying the visibility.
/// * NWNX_VISIBILITY_DEFAULT = Override not set.
/// * NWNX_VISIBILITY_VISIBLE = Target is visible but still adheres to default visibility rules.
/// * NWNX_VISIBILITY_HIDDEN = Target is always hidden.
/// * NWNX_VISIBILITY_DM_ONLY = Target is only visible to DMs but still adheres to default visibility rules.
/// * NWNX_VISIBILITY_ALWAYS_VISIBLE = Target is always visible in all circumstances.
/// * NWNX_VISIBILITY_ALWAYS_VISIBLE_DM_ONLY = Target is always visible only to DMs in all circumstances.
///
/// @param oPlayer The PC Object or OBJECT_INVALID.
/// @param oTarget The object for which we're querying the visibility override.
/// @return The @ref vis_types "Visibility Type".
int NWNX_Visibility_GetVisibilityOverride(object player, object target);
int NWNX_Visibility_GetVisibilityOverride(object oPlayer, object oTarget);
/// @brief Overrides the default visibility rules about how player perceives the target object.
/// @brief Overrides the default visibility rules about how oPlayer perceives oTarget.
/// If oPlayer is OBJECT_INVALID, the global visibility override will be set.
///
/// If player is OBJECT_INVALID, the global visibility override will be set
/// * Player == VALID -> override:
/// * NWNX_VISIBILITY_DEFAULT = Remove the player override
/// * NWNX_VISIBILITY_VISIBLE = Target is always visible for player
/// * NWNX_VISIBILITY_HIDDEN = Target is always hidden for player
/// * Player == OBJECT_INVALID -> override:
/// * NWNX_VISIBILITY_DEFAULT = Remove the global override
/// * NWNX_VISIBILITY_VISIBLE = Target is globally visible
/// * NWNX_VISIBILITY_HIDDEN = Target is globally hidden
/// * NWNX_VISIBILITY_DM_ONLY = Target is only visible to DMs
/// * NWNX_VISIBILITY_DEFAULT = Remove a set override.
/// * NWNX_VISIBILITY_VISIBLE = Target is visible but still adheres to default visibility rules.
/// * NWNX_VISIBILITY_HIDDEN = Target is always hidden.
/// * NWNX_VISIBILITY_DM_ONLY = Target is only visible to DMs but still adheres to default visibility rules.
/// * NWNX_VISIBILITY_ALWAYS_VISIBLE = Target is always visible in all circumstances.
/// * NWNX_VISIBILITY_ALWAYS_VISIBLE_DM_ONLY = Target is always visible to DMs in all circumstances.
///
/// @warning Setting too many objects to ALWAYS_VISIBLE in an area will impact the performance of your players. Use sparingly.
///
/// @note Player state overrides the global state which means if a global state is set
/// to NWNX_VISIBILITY_HIDDEN or NWNX_VISIBILITY_DM_ONLY but the player's state is
/// set to NWNX_VISIBILITY_VISIBLE for the target, the object will be visible to the player.
/// @param player The PC Object or OBJECT_INVALID.
/// @param target The object for which we're altering the visibility.
/// @param override The visibility type from @ref vis_types "Visibility Types".
void NWNX_Visibility_SetVisibilityOverride(object player, object target, int override);
///
/// @param oPlayer The PC Object or OBJECT_INVALID.
/// @param oTarget The object for which we're altering the visibility.
/// @param nOverride The visibility type from @ref vis_types "Visibility Types".
void NWNX_Visibility_SetVisibilityOverride(object oPlayer, object oTarget, int nOverride);
/// @}
int NWNX_Visibility_GetVisibilityOverride(object player, object target)
int NWNX_Visibility_GetVisibilityOverride(object oPlayer, object oTarget)
{
string sFunc = "GetVisibilityOverride";
NWNX_PushArgumentObject(NWNX_Visibility, sFunc, target);
NWNX_PushArgumentObject(NWNX_Visibility, sFunc, player);
NWNX_CallFunction(NWNX_Visibility, sFunc);
return NWNX_GetReturnValueInt(NWNX_Visibility, sFunc);
NWNXPushObject(oTarget);
NWNXPushObject(oPlayer);
NWNXCall(NWNX_Visibility, "GetVisibilityOverride");
return NWNXPopInt();
}
void NWNX_Visibility_SetVisibilityOverride(object player, object target, int override)
void NWNX_Visibility_SetVisibilityOverride(object oPlayer, object oTarget, int nOverride)
{
string sFunc = "SetVisibilityOverride";
NWNX_PushArgumentInt(NWNX_Visibility, sFunc, override);
NWNX_PushArgumentObject(NWNX_Visibility, sFunc, target);
NWNX_PushArgumentObject(NWNX_Visibility, sFunc, player);
NWNX_CallFunction(NWNX_Visibility, sFunc);
NWNXPushInt(nOverride);
NWNXPushObject(oTarget);
NWNXPushObject(oPlayer);
NWNXCall(NWNX_Visibility, "SetVisibilityOverride");
}

View File

@@ -2,7 +2,6 @@
/// @brief Functions exposing additional weapon properties.
/// @{
/// @file nwnx_weapon.nss
#include "nwnx"
const string NWNX_Weapon = "NWNX_Weapon"; ///< @private
@@ -94,6 +93,7 @@ void NWNX_Weapon_SetGreaterWeaponFocusFeat(int nBaseItem, int nFeat);
/// @brief Set base item as monk weapon.
/// @param nBaseItem The base item id.
/// @deprecated Use baseitems.2da. This will be removed in future NWNX releases.
void NWNX_Weapon_SetWeaponIsMonkWeapon(int nBaseItem);
/// @brief Set plugin options.
@@ -114,187 +114,175 @@ struct NWNX_Weapon_DevastatingCriticalEvent_Data NWNX_Weapon_GetDevastatingCriti
/// @note This is only for use with the Devastating Critical Event Script.
void NWNX_Weapon_BypassDevastatingCritical();
/// @brief Sets weapon to gain .5 strength bonus.
/// @param oWeapon Should be a melee weapon.
/// @param nEnable TRUE for bonus. FALSE to turn off bonus.
/// @param bPersist whether the two hand state should persist to the gff file.
void NWNX_Weapon_SetOneHalfStrength(object oWeapon, int nEnable, int bPersist = FALSE);
/// @brief Gets if the weapon is set to gain addition .5 strength bonus
/// @param oWeapon the weapon
/// @return FALSE/0 if weapon is not receiving the bonus. TRUE/1 if it does.
int NWNX_Weapon_GetOneHalfStrength(object oWeapon);
/// @brief Override the max attack distance of ranged weapons.
/// @param nBaseItem The baseitem id.
/// @param fMax The maximum attack distance. Default is 40.0f.
/// @param fMaxPassive The maximum passive attack distance. Default is 20.0f. Seems to be used by the engine to determine a new nearby target when needed.
/// @param fPreferred The preferred attack distance. See the PrefAttackDist column in baseitems.2da, default seems to be 30.0f for ranged weapons.
/// @note fMaxPassive should probably be lower than fMax, half of fMax seems to be a good start. fPreferred should be at least ~0.5f lower than fMax.
void NWNX_Weapon_SetMaxRangedAttackDistanceOverride(int nBaseItem, float fMax, float fMaxPassive, float fPreferred);
/// @}
void NWNX_Weapon_SetWeaponFocusFeat(int nBaseItem, int nFeat)
{
string sFunc = "SetWeaponFocusFeat";
NWNX_PushArgumentInt(NWNX_Weapon, sFunc, nFeat);
NWNX_PushArgumentInt(NWNX_Weapon, sFunc, nBaseItem);
NWNX_CallFunction(NWNX_Weapon, sFunc);
NWNXPushInt(nFeat);
NWNXPushInt(nBaseItem);
NWNXCall(NWNX_Weapon, "SetWeaponFocusFeat");
}
void NWNX_Weapon_SetEpicWeaponFocusFeat(int nBaseItem, int nFeat)
{
string sFunc = "SetEpicWeaponFocusFeat";
NWNX_PushArgumentInt(NWNX_Weapon, sFunc, nFeat);
NWNX_PushArgumentInt(NWNX_Weapon, sFunc, nBaseItem);
NWNX_CallFunction(NWNX_Weapon, sFunc);
NWNXPushInt(nFeat);
NWNXPushInt(nBaseItem);
NWNXCall(NWNX_Weapon, "SetEpicWeaponFocusFeat");
}
void NWNX_Weapon_SetGreaterWeaponFocusFeat(int nBaseItem, int nFeat)
{
string sFunc = "SetGreaterWeaponFocusFeat";
NWNX_PushArgumentInt(NWNX_Weapon, sFunc, nFeat);
NWNX_PushArgumentInt(NWNX_Weapon, sFunc, nBaseItem);
NWNX_CallFunction(NWNX_Weapon, sFunc);
NWNXPushInt(nFeat);
NWNXPushInt(nBaseItem);
NWNXCall(NWNX_Weapon, "SetGreaterWeaponFocusFeat");
}
void NWNX_Weapon_SetWeaponFinesseSize(int nBaseItem, int nSize)
{
string sFunc = "SetWeaponFinesseSize";
NWNX_PushArgumentInt(NWNX_Weapon, sFunc, nSize);
NWNX_PushArgumentInt(NWNX_Weapon, sFunc, nBaseItem);
NWNX_CallFunction(NWNX_Weapon, sFunc);
NWNXPushInt(nSize);
NWNXPushInt(nBaseItem);
NWNXCall(NWNX_Weapon, "SetWeaponFinesseSize");
}
int NWNX_Weapon_GetWeaponFinesseSize(int nBaseItem)
{
string sFunc = "GetWeaponFinesseSize";
NWNX_PushArgumentInt(NWNX_Weapon, sFunc, nBaseItem);
NWNX_CallFunction(NWNX_Weapon, sFunc);
return NWNX_GetReturnValueInt(NWNX_Weapon, sFunc);
NWNXPushInt(nBaseItem);
NWNXCall(NWNX_Weapon, "GetWeaponFinesseSize");
return NWNXPopInt();
}
void NWNX_Weapon_SetWeaponUnarmed(int nBaseItem)
{
string sFunc = "SetWeaponUnarmed";
NWNX_PushArgumentInt(NWNX_Weapon, sFunc, nBaseItem);
NWNX_CallFunction(NWNX_Weapon, sFunc);
NWNXPushInt(nBaseItem);
NWNXCall(NWNX_Weapon, "SetWeaponUnarmed");
}
void NWNX_Weapon_SetWeaponIsMonkWeapon(int nBaseItem)
{
string sFunc = "SetWeaponIsMonkWeapon";
NWNX_PushArgumentInt(NWNX_Weapon, sFunc, nBaseItem);
NWNX_CallFunction(NWNX_Weapon, sFunc);
WriteTimestampedLogEntry("NWNX_Weapon_SetWeaponIsMonkWeapon() is deprecated. Please use baseitems.2da instead.");
NWNXPushInt(nBaseItem);
NWNXCall(NWNX_Weapon, "SetWeaponIsMonkWeapon");
}
void NWNX_Weapon_SetWeaponImprovedCriticalFeat(int nBaseItem, int nFeat)
{
string sFunc = "SetWeaponImprovedCriticalFeat";
NWNX_PushArgumentInt(NWNX_Weapon, sFunc, nFeat);
NWNX_PushArgumentInt(NWNX_Weapon, sFunc, nBaseItem);
NWNX_CallFunction(NWNX_Weapon, sFunc);
NWNXPushInt(nFeat);
NWNXPushInt(nBaseItem);
NWNXCall(NWNX_Weapon, "SetWeaponImprovedCriticalFeat");
}
void NWNX_Weapon_SetWeaponSpecializationFeat(int nBaseItem, int nFeat)
{
string sFunc = "SetWeaponSpecializationFeat";
NWNX_PushArgumentInt(NWNX_Weapon, sFunc, nFeat);
NWNX_PushArgumentInt(NWNX_Weapon, sFunc, nBaseItem);
NWNX_CallFunction(NWNX_Weapon, sFunc);
NWNXPushInt(nFeat);
NWNXPushInt(nBaseItem);
NWNXCall(NWNX_Weapon, "SetWeaponSpecializationFeat");
}
void NWNX_Weapon_SetGreaterWeaponSpecializationFeat(int nBaseItem, int nFeat)
{
string sFunc = "SetGreaterWeaponSpecializationFeat";
NWNX_PushArgumentInt(NWNX_Weapon, sFunc, nFeat);
NWNX_PushArgumentInt(NWNX_Weapon, sFunc, nBaseItem);
NWNX_CallFunction(NWNX_Weapon, sFunc);
NWNXPushInt(nFeat);
NWNXPushInt(nBaseItem);
NWNXCall(NWNX_Weapon, "SetGreaterWeaponSpecializationFeat");
}
void NWNX_Weapon_SetEpicWeaponSpecializationFeat(int nBaseItem, int nFeat)
{
string sFunc = "SetEpicWeaponSpecializationFeat";
NWNX_PushArgumentInt(NWNX_Weapon, sFunc, nFeat);
NWNX_PushArgumentInt(NWNX_Weapon, sFunc, nBaseItem);
NWNX_CallFunction(NWNX_Weapon, sFunc);
NWNXPushInt(nFeat);
NWNXPushInt(nBaseItem);
NWNXCall(NWNX_Weapon, "SetEpicWeaponSpecializationFeat");
}
void NWNX_Weapon_SetEpicWeaponOverwhelmingCriticalFeat(int nBaseItem, int nFeat)
{
string sFunc = "SetEpicWeaponOverwhelmingCriticalFeat";
NWNX_PushArgumentInt(NWNX_Weapon, sFunc, nFeat);
NWNX_PushArgumentInt(NWNX_Weapon, sFunc, nBaseItem);
NWNX_CallFunction(NWNX_Weapon, sFunc);
NWNXPushInt(nFeat);
NWNXPushInt(nBaseItem);
NWNXCall(NWNX_Weapon, "SetEpicWeaponOverwhelmingCriticalFeat");
}
void NWNX_Weapon_SetEpicWeaponDevastatingCriticalFeat(int nBaseItem, int nFeat)
{
string sFunc = "SetEpicWeaponDevastatingCriticalFeat";
NWNX_PushArgumentInt(NWNX_Weapon, sFunc, nFeat);
NWNX_PushArgumentInt(NWNX_Weapon, sFunc, nBaseItem);
NWNX_CallFunction(NWNX_Weapon, sFunc);
NWNXPushInt(nFeat);
NWNXPushInt(nBaseItem);
NWNXCall(NWNX_Weapon, "SetEpicWeaponDevastatingCriticalFeat");
}
void NWNX_Weapon_SetWeaponOfChoiceFeat(int nBaseItem, int nFeat)
{
string sFunc = "SetWeaponOfChoiceFeat";
NWNX_PushArgumentInt(NWNX_Weapon, sFunc, nFeat);
NWNX_PushArgumentInt(NWNX_Weapon, sFunc, nBaseItem);
NWNX_CallFunction(NWNX_Weapon, sFunc);
NWNXPushInt(nFeat);
NWNXPushInt(nBaseItem);
NWNXCall(NWNX_Weapon, "SetWeaponOfChoiceFeat");
}
void NWNX_Weapon_SetOption(int nOption, int nVal)
{
string sFunc = "SetOption";
NWNX_PushArgumentInt(NWNX_Weapon, sFunc, nVal);
NWNX_PushArgumentInt(NWNX_Weapon, sFunc, nOption);
NWNX_CallFunction(NWNX_Weapon, sFunc);
NWNXPushInt(nVal);
NWNXPushInt(nOption);
NWNXCall(NWNX_Weapon, "SetOption");
}
void NWNX_Weapon_SetDevastatingCriticalEventScript(string sScript)
{
string sFunc = "SetDevastatingCriticalEventScript";
NWNX_PushArgumentString(NWNX_Weapon, sFunc, sScript);
NWNX_CallFunction(NWNX_Weapon, sFunc);
NWNXPushString(sScript);
NWNXCall(NWNX_Weapon, "SetDevastatingCriticalEventScript");
}
void NWNX_Weapon_BypassDevastatingCritical()
{
string sFunc = "SetEventData";
NWNX_PushArgumentInt(NWNX_Weapon, sFunc, 1);
NWNX_PushArgumentInt(NWNX_Weapon, sFunc, NWNX_WEAPON_SETDATA_DC_BYPASS);
NWNX_CallFunction(NWNX_Weapon, sFunc);
NWNXPushInt(1);
NWNXPushInt(NWNX_WEAPON_SETDATA_DC_BYPASS);
NWNXCall(NWNX_Weapon, "SetEventData");
}
struct NWNX_Weapon_DevastatingCriticalEvent_Data NWNX_Weapon_GetDevastatingCriticalEventData()
{
string sFunc = "GetEventData";
struct NWNX_Weapon_DevastatingCriticalEvent_Data data;
NWNX_PushArgumentInt(NWNX_Weapon, sFunc, NWNX_WEAPON_GETDATA_DC);
NWNX_CallFunction(NWNX_Weapon, sFunc);
data.oWeapon = NWNX_GetReturnValueObject(NWNX_Weapon, sFunc);
data.oTarget = NWNX_GetReturnValueObject(NWNX_Weapon, sFunc);
data.nDamage = NWNX_GetReturnValueInt(NWNX_Weapon, sFunc);
NWNXPushInt(NWNX_WEAPON_GETDATA_DC);
NWNXCall(NWNX_Weapon, "GetEventData");
data.oWeapon = NWNXPopObject();
data.oTarget = NWNXPopObject();
data.nDamage = NWNXPopInt();
return data;
}
void NWNX_Weapon_SetOneHalfStrength(object oWeapon, int nEnable, int bPersist = FALSE)
{
NWNXPushInt(bPersist);
NWNXPushInt(nEnable);
NWNXPushObject(oWeapon);
NWNXCall(NWNX_Weapon, "SetOneHalfStrength");
}
int NWNX_Weapon_GetOneHalfStrength(object oWeapon)
{
NWNXPushObject(oWeapon);
NWNXCall(NWNX_Weapon, "GetOneHalfStrength");
return NWNXPopInt();
}
void NWNX_Weapon_SetMaxRangedAttackDistanceOverride(int nBaseItem, float fMax, float fMaxPassive, float fPreferred)
{
NWNXPushFloat(fPreferred);
NWNXPushFloat(fMaxPassive);
NWNXPushFloat(fMax);
NWNXPushInt(nBaseItem);
NWNXCall(NWNX_Weapon, "SetMaxRangedAttackDistanceOverride");
}

View File

@@ -2,7 +2,6 @@
/// @brief Send messages to external entities through web hooks.
/// @{
/// @file nwnx_webhook.nss
#include "nwnx"
const string NWNX_WebHook = "NWNX_WebHook"; ///< @private
@@ -28,13 +27,12 @@ void NWNX_WebHook_ResendWebHookHTTPS(string host, string path, string sMessage,
void NWNX_WebHook_SendWebHookHTTPS(string host, string path, string message, string username = "", int mrkdwn = 1)
{
string sFunc = "SendWebHookHTTPS";
NWNX_PushArgumentInt(NWNX_WebHook, sFunc, mrkdwn);
NWNX_PushArgumentString(NWNX_WebHook, sFunc, username);
NWNX_PushArgumentString(NWNX_WebHook, sFunc, message);
NWNX_PushArgumentString(NWNX_WebHook, sFunc, path);
NWNX_PushArgumentString(NWNX_WebHook, sFunc, host);
NWNX_CallFunction(NWNX_WebHook, sFunc);
NWNXPushInt(mrkdwn);
NWNXPushString(username);
NWNXPushString(message);
NWNXPushString(path);
NWNXPushString(host);
NWNXCall(NWNX_WebHook, "SendWebHookHTTPS");
}
void NWNX_WebHook_ResendWebHookHTTPS(string host, string path, string sMessage, float delay = 0.0f)