FromJSON: Difference between revisions

Latest revision as of 09:33, 29 September 2019

This function parses a JSON formatted string into variables. You can use toJSON to encode variables into a JSON string that can be read by this function.

Syntax

var fromJSON ( string json )

Required Arguments

json: A JSON formatted string

Returns

Returns variables read from the JSON string.

Note: Indices of a JSON object such as "1": "cat" are being returned as string, not as integer.

Example

This makes data equal: { ["1"] = "cat", ["2"] = "mouse", ["3"] = 5, ["4"] = null, ["cat"] = 5, ["mouse"] =1 }

local data = fromJSON ( '[ { "1": "cat", "2": "mouse", "3": 5, "4": null, "cat":5, "mouse":1 } ]' )

Example 2

local name, weapon, ammo = fromJSON("[\"Desert Eagle\", 24, 147]")

Requirements

Minimum server version	1.0
Minimum client version	1.1.1-9.03316

Note: Using this feature requires the resource to have the above minimum version declared in the meta.xml <min_mta_version> section. e.g. <min_mta_version server="1.0" client="1.1.1-9.03316" />

@@ Line 1: / Line 1: @@
 __NOTOC__
-{{Server client function}}<!-- Change this to "Client function" or "Server function" appropriately-->
+{{Server client function}}
-<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
+This function parses a [[JSON]] formatted string into variables. You can use [[toJSON]] to encode variables into a JSON string that can be read by this function.
-This fake function is for use with blah & blah and does blahblahblabhalbhl
 ==Syntax==
-<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->
 <syntaxhighlight lang="lua">
-returnType functionName ( arguments )
+var fromJSON ( string json )
 </syntaxhighlight>
 ===Required Arguments===
-<!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type -->
+*'''json:''' A JSON formatted string
-*'''argumentName:''' description
-<!-- Only include this section below if there are optional arguments -->
+===Returns===
-===Optional Arguments===
+Returns variables read from the JSON string.
-{{OptionalArg}}
-*'''argumentName2:''' description
-*'''argumentName3:''' description
-===Returns===
+'''Note:''' Indices of a JSON object such as "1": "cat" are being returned as [[string]], not as [[int]]eger.
-<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->
-Returns ''true'' if blah, ''false'' otherwise.
 ==Example==
-<!-- Explain what the example is in a single sentance -->
+This makes data equal: ''{ ["1"] = "cat", ["2"] = "mouse", ["3"] = 5, ["4"] = null, ["cat"] = 5, ["mouse"] =1 }''
-This example does...
+<syntaxhighlight lang="lua">
-<!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized -->
+local data = fromJSON ( '[ { "1": "cat", "2": "mouse", "3": 5, "4": null, "cat":5, "mouse":1 } ]' )
+</syntaxhighlight>
+==Example 2==
 <syntaxhighlight lang="lua">
---This line does...
+local name, weapon, ammo = fromJSON("[\"Desert Eagle\", 24, 147]")
-blabhalbalhb --abababa
---This line does this...
-mooo
 </syntaxhighlight>
+==Requirements==
+{{Requirements|1.0|1.1.1-9.03316|}}
 ==See Also==
-<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->
 {{Server_functions}}
-[[Category:Needs_Example]] <!-- leave this until the example is completed. -->
-[[Category:Need_Syntax]] <!-- leave this until syntax is available. Cannot document the function or event without syntax. -->
-[[Category:Incomplete]] <!-- leave this unless you complete the function -->