JsonGetLength(json)

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 the length of the given json type.

int JsonGetLength(
    json jValue
);

Parameters

jValue

The json data to analyze.

Description

Returns the length of the given json type. For objects, returns the number of top-level keys present. For arrays, returns the number of elements. Null types are of size 0. All other types return 1.

Remarks

Calling JsonGetLength on null json will return size of 0. You can test it's null-ness JsonGetType.

Version

This function was added in 1.85.8193.31 of NWN:EE.

Example

	// Create array
	json jsonData = JsonArray();

	// Add two d20 rolls (as JsonInts) to array:
	jsonData	  = JsonArrayInsert(jsonData, JsonInt(d20()));
	jsonData	  = JsonArrayInsert(jsonData, JsonInt(d20()));

	// Get size of array, should be 2 since that's all we added
	int nSize = JsonGetLength(jsonData);

	// Prints Message to PC: "nSize: 2"
	SendMessageToPC(GetFirstPC(), "nSize: " + IntToString(nSize));

See Also

functions:

JSON Functions