XmlLoadData: Difference between revisions
No edit summary |
No edit summary |
||
Line 12: | Line 12: | ||
This function provides an automated way of loading your data from an [[XML]] file created by [[xmlSaveData]] <br> | This function provides an automated way of loading your data from an [[XML]] file created by [[xmlSaveData]] <br> | ||
To call | To call it, see the [[call]] function or the tip in this resources page: [https://wiki.multitheftauto.com/wiki/XmlData#Simplifying_the_export Simplifying the export] | ||
= Info = | = Info = | ||
''' | '''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.''' | ||
Line 23: | Line 23: | ||
<section name="Client" class="client" show="true"> | <section name="Client" class="client" show="true"> | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
bool xmlLoadData ( fileName [, serverProtected, resourceProtected ] ) | bool xmlLoadData ( string fileName [, bool serverProtected = true, bool resourceProtected = false ] ) | ||
bool xmlLoadData ( fileName [, int securityLevel ] ) | bool xmlLoadData ( string fileName [, int securityLevel = 4 ] ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Line 50: | Line 50: | ||
<section name="Server" class="server" show="true"> | <section name="Server" class="server" show="true"> | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
bool xmlLoadData ( fileName [, resourceProtected ] ) | bool xmlLoadData ( string fileName [, bool resourceProtected ] ) | ||
bool xmlLoadData ( fileName [, int securityLevel ] ) | bool xmlLoadData ( string fileName [, int securityLevel ] ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Revision as of 18:11, 12 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 ] )
bool xmlSaveData ( string fileName, table data [, int securityLevel = 4] )
Required Arguments
- fileName: The name of the file you want to create
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 you want to store your data 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 ] ) bool xmlLoadData ( string fileName [, int securityLevel ] )
bool xmlSaveData ( string fileName, table data [, int securityLevel = 4] )
Required Arguments
- fileName: The name of the file you want to create
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 you want to store your data 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