JsonArrayDel(json, int)

Note: This article documents Neverwinter Nights: Enhanced Edition new content or changes/updates/fixes to 1.69 functions. These are all listed under the category and patches pages.

Returns a modified copy of jArray with the element at position nIndex removed, and the array resized by one.

json JsonArrayDel(
    json jArray,
    int nIndex
);

Parameters

jArray

The json Array to modify.

nIndex

The index to set for a value.

Description

Returns a modified copy of jArray with the element at position nIndex removed, and the array resized by one.

Remarks

Returns a json null value if jArray is not actually an array, with JsonGetError filled in. Returns a json null value if nIndex is out of bounds, with JsonGetError filled in.

Version

This function was added in 1.85.8193.31 of NWN:EE.

Example

void main()
{
    json jArray = JsonParse("{[1, 2, 3, 4, 5]}");
    // Delete the element at position 2 (the third element, which is '3'). We assign the result of the function to the same variable.
    jArray = JsonArrayDel(jArray, 2);
    WriteTimestampedLogEntry(JsonDump(jArray)); // {[1, 2, 4, 5]}
}

See Also

functions:

JSON Functions