Skip to main content
Version: bleeding-edge 🩸

JSON

JSON library.

🗿Static Class
This is a Static Class. Access it's methods directly with .. It's not possible to spawn new instances.
🧑‍💻API Source
The methods, properties and events descriptions from this page are defined in our GitHub API Repository!

🎒 Examples

(JSON.stringify) Stringifies a Lua table
local encoded_value = JSON.stringify({ 1, 2, 3, { x = 10, y = Vector(1, 2, 3) }, "he" })
-- Outputs "[1,2,3,{"x":10,"y":"Vector(1.0, 2.0, 3.0)"},"he"]"
(JSON.parse) Parses a JSON string into a Lua table
local decoded_value = JSON.parse('[1,2,3,{"x":10,"y":"Vector(1.0, 2.0, 3.0)"},"he"]')
-- Outputs "the table { 1, 2, 3, { x = 10, y = Vector(1, 2, 3) }, "he" }"
note

Note that custom classes (e.g. Vehicle, Character, Prop... etc) or functions are not supported to be stringified and will be nullified.

Structs (e.g. Vector, Rotator, Color... etc) are supported and will be parsed/stringified properly!

🗿 Static Functions

ReturnsNameDescription
stringstringifyReturns a string representing value encoded in JSON
anyparseReturns a value representing the decoded JSON string

stringify

Returns a string representing value encoded in JSON

— Returns string (the table in JSON).

local ret = JSON.stringify(value)
TypeParameterDefaultDescription
tablevaluethe table that will become JSON
JSON.stringify Examples
Stringifies a Lua table
local encoded_value = JSON.stringify({ 1, 2, 3, { x = 10, y = Vector(1, 2, 3) }, "he" })
-- Outputs "[1,2,3,{"x":10,"y":"Vector(1.0, 2.0, 3.0)"},"he"]"

parse

Returns a value representing the decoded JSON string

— Returns any (the json in table).

local ret = JSON.parse(value)
TypeParameterDefaultDescription
stringvaluethe JSON that will become a table
JSON.parse Examples
Parses a JSON string into a Lua table
local decoded_value = JSON.parse('[1,2,3,{"x":10,"y":"Vector(1.0, 2.0, 3.0)"},"he"]')
-- Outputs "the table { 1, 2, 3, { x = 10, y = Vector(1, 2, 3) }, "he" }"