JsonObjectDel(json, string)

From NWN Lexicon
Jump to navigationJump to search
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 jObject with the key at sKey deleted.

json JsonObjectDel(
    json jObject,
    string sKey
);


Parameters

jObject
The json Object to modify.
sKey
The key to set for a value.


Description

Returns a modified copy of jObject with the key at sKey deleted.


Remarks

Returns a json null value if jObject is not a object, with JsonGetError filled in.


Version

This function was added in 1.85.8193.31 of NWN:EE.


Example

void main() 
{
    json jObject = JsonParse("{"CharName": "John", "CharLevel": "1"}");
	
    // Delete the "CharLevel" property from the json. We assign the result of the function to the same variable.
    jObject = JsonObjectDel(jObject, "CharLevel");
    WriteTimestampedLogEntry(JsonDump(jObject)); // {"CharName": "John"}
}

See Also

functions:

JSON Functions