ToJSON: Difference between revisions
Jump to navigation
Jump to search
-ffs-Sniper (talk | contribs) (ToJSON was described wrong, it only grabs one argument, updated syntax, description and example) |
|||
| Line 4: | Line 4: | ||
Available client side in 1.2 and onwards | Available client side in 1.2 and onwards | ||
}} | }} | ||
This function converts one | This function converts '''one''' variable (preferably a table) into a [[JSON]] encoded string. You can use this to store the data and then load it again using [[fromJSON]]. | ||
==Syntax== | ==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 --> | <!-- 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"> | <syntaxhighlight lang="lua"> | ||
string toJSON( var | string toJSON( var value ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
===Required Arguments=== | ===Required Arguments=== | ||
*''' | *'''var:''' An arguments of any type. Arguments that are elements will be stored as element IDs that are liable to change between sessions. As such, do not save elements across sessions as you will get unpredictable results. | ||
===Returns=== | ===Returns=== | ||
| Line 19: | Line 19: | ||
==Example== | ==Example== | ||
This example shows how you can encode an array. The string json should equal ''"[" | This example shows how you can encode an array. The string json should equal ''"[ { "1": "dogs", "mouse": "food", "cat": "hungry", "birds": 4 } ]" after executed. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
local json = toJSON ( " | local json = toJSON ( { "dogs", cat = "hungry", mouse = "food", birds = 4 } ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Revision as of 19:00, 29 March 2012
Available client side in 1.2 and onwards This function converts one variable (preferably a table) into a JSON encoded string. You can use this to store the data and then load it again using fromJSON.
Syntax
string toJSON( var value )
Required Arguments
- var: An arguments of any type. Arguments that are elements will be stored as element IDs that are liable to change between sessions. As such, do not save elements across sessions as you will get unpredictable results.
Returns
Returns a JSON formatted string.
Example
This example shows how you can encode an array. The string json should equal "[ { "1": "dogs", "mouse": "food", "cat": "hungry", "birds": 4 } ]" after executed.
local json = toJSON ( { "dogs", cat = "hungry", mouse = "food", birds = 4 } )
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" />
See Also
- getFPSLimit
- getMaxPlayers
- getServerHttpPort
- getServerName
- getServerPassword
- getServerPort
- getVersion
- isGlitchEnabled
- isTransferBoxAlwaysVisible
- isTransferBoxVisible
- setFPSLimit
- setGlitchEnabled
- setMaxPlayers
- setServerPassword
- setTransferBoxVisible
- shutdown