XmlLoadData: Difference between revisions
No edit summary |
mNo edit summary |
||
| (11 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
<pageclass class="#228B22" subcaption="Useful Function - Shared"></pageclass> | <pageclass class="#228B22" subcaption="Useful Function - Shared"></pageclass> | ||
<lowercasetitle></lowercasetitle> | <lowercasetitle></lowercasetitle> | ||
__NOTOC__ | |||
{{Important Note| | {{Important Note| | ||
| Line 16: | Line 15: | ||
= Info = | = Info = | ||
'''For proper data loading you need to pass the same booleans/securityLevel as you did on xmlSaveData.'''<br> | '''For proper data loading you need to pass the same booleans / securityLevel as you did on xmlSaveData.'''<br> | ||
'''If you called [[xmlSaveData]] with passing the securityLevel its recommended to pick securityLevel as function paremeter for the loading as well.''' | '''If you called [[xmlSaveData]] with passing the securityLevel its recommended to pick securityLevel as function paremeter for the loading as well.''' | ||
| Line 24: | Line 23: | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
bool xmlLoadData ( string fileName [, bool serverProtected = true, bool resourceProtected = false ] ) | bool xmlLoadData ( string fileName [, bool serverProtected = true, bool resourceProtected = false ] ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 32: | Line 30: | ||
====Required Arguments==== | ====Required Arguments==== | ||
*'''fileName:''' The name of the file you want to | *'''fileName:''' The name of the file you want to load. | ||
====Optional Arguments==== | ====Optional Arguments==== | ||
| Line 58: | Line 56: | ||
====Required Arguments==== | ====Required Arguments==== | ||
*'''fileName:''' The name of the file you want to | *'''fileName:''' The name of the file you want to load. | ||
====Optional Arguments==== | ====Optional Arguments==== | ||
| Line 70: | Line 68: | ||
Returns a ''table'' containing the files data, an empty ''table'' if there is no data stored inside the file, ''false'' and debug output in case if failure. | Returns a ''table'' containing the files data, an empty ''table'' if there is no data stored inside the file, ''false'' and debug output in case if failure. | ||
'''Note1: There is no encryption parameter, because xmlLoadData will load and use a files key if it is encrypted.''' | '''Note1: There is no encryption parameter, because xmlLoadData will load and use a files key if it is encrypted.'''<br> | ||
'''Note2: There is no serverProtected parameter, because its server-side already anyways. | '''Note2: There is no serverProtected parameter, because its server-side already anyways. | ||
</section> | </section> | ||
| Line 85: | Line 83: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
</section> | </section> | ||
==See Also== | |||
{{Template:Shared_xml_functions}} | |||
[[Category:Useful Functions]] | |||
Latest revision as of 16:36, 13 September 2019
| Important Note:
This is an unofficial MTA function, so its not included into the game by default. |
This function provides an automated way of loading your data from an XML file created by xmlSaveData
To call it, see the call function or the tip in this resources page: Simplifying the export
Info
For proper data loading you need to pass the same booleans / securityLevel as you did on xmlSaveData.
If you called xmlSaveData with passing the securityLevel its recommended to pick securityLevel as function paremeter for the loading as well.
Syntax
bool xmlLoadData ( string fileName [, bool serverProtected = true, bool resourceProtected = false ] )
bool xmlLoadData ( string fileName [, int securityLevel = 4 ] )
Required Arguments
- fileName: The name of the file you want to load.
Optional Arguments
- serverProtected: If set to true it can only read the file of the creator-server, otherwise it doesn't care which server created it.
- resourceProtected: If set to true it can only read the file of the creator-resource, otherwise it doesn't care which resource created it.
or
- securityLevel: The level of security on which your data is stored at. (Details on the resource page: Security Levels)
See xmlData Variables and Specified names for more detail.
Returns
Returns a table containing the files data, an empty table if there is no data stored inside the file, false and debug output in case if failure.
Note: There is no encryption parameter in this function, because xmlLoadData will load and use a files key if it is encrypted.
bool xmlLoadData ( string fileName [, bool resourceProtected = false ] )
bool xmlSaveData ( string fileName [, int securityLevel = 4] )
Required Arguments
- fileName: The name of the file you want to load.
Optional Arguments
- resourceProtected: If set to true it can only read the file of the creator-resource, otherwise it doesn't care which resource created it.
or
- securityLevel: The level of security on which your data is stored at. (Details on the resource page: Security Levels)
See xmlData Variables and Specified names for more detail.
Returns
Returns a table containing the files data, an empty table if there is no data stored inside the file, false and debug output in case if failure.
Note1: There is no encryption parameter, because xmlLoadData will load and use a files key if it is encrypted.
Note2: There is no serverProtected parameter, because its server-side already anyways.
Example
-- Lets assume we created a encrypted, serverProtected file called "settings" already.
local xml = exports.xmlData
local tblSettings = xml:xmlLoadData("settings" true) -- serverProtected is true, resourceProtected false - false doesnt need to get passed here
-- OR you can do this:
local tblSettings = xml:xmlLoadData("settings" 6) -- securityLevel 6 equals serverProtected, encrypted, not resouceProtected - the encryption bool will be ignored at xmlLoadData