XmlLoadData

2019-09-12T18:56:04Z

Ceeser:

<pageclass class="#228B22" subcaption="Useful Function - Shared"></pageclass>
<lowercasetitle></lowercasetitle>

{{Important Note|
This is an unofficial MTA function, so its not included into the game by default.<br>
Its an exported function of the [[xmlData]] resource.<br>
To access this function you need to have the resource running on your server.}}

This function provides an automated way of loading your data from an [[XML]] file created by [[xmlSaveData]] <br>
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 =
'''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.'''

= Syntax =
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
bool xmlLoadData ( string fileName [, bool serverProtected = true, bool resourceProtected = false ] )
</syntaxhighlight>

<syntaxhighlight lang="lua">
bool xmlLoadData ( string fileName [, int securityLevel = 4 ] )
</syntaxhighlight>

====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: [https://wiki.multitheftauto.com/wiki/XmlData#Security_Levels Security Levels])

'''See [https://wiki.multitheftauto.com/wiki/XmlData#Variables_and_Specified_Names 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.'''
</section>

<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
bool xmlLoadData ( string fileName [, bool resourceProtected = false ] )
</syntaxhighlight>

<syntaxhighlight lang="lua">
bool xmlSaveData ( string fileName [, int securityLevel = 4] )
</syntaxhighlight>

====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: [https://wiki.multitheftauto.com/wiki/XmlData#Security_Levels Security Levels])

'''See [https://wiki.multitheftauto.com/wiki/XmlData#Variables_and_Specified_Names 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.'''<br>
'''Note2: There is no serverProtected parameter, because its server-side already anyways.
</section>

== Example ==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
-- 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
</syntaxhighlight>
</section>

==See Also==
{{XML_functions}}
{{Shared_xml_functions}}

[[Category:Useful Functions]]

XmlLoadData

2019-09-12T18:54:22Z

Ceeser:

XmlSaveData

2019-09-12T18:52:55Z

Ceeser:

<pageclass class="#228B22" subcaption="Useful Function - Shared"></pageclass>
<lowercasetitle></lowercasetitle>

{{Important Note|
This is an unofficial MTA function, so its not included into the game by default.<br>
Its an exported function of the [[xmlData]] resource.<br>
To access this function you need to have the resource running on your server.}}

This function provides an automated way of loading your data from an [[XML]] file created by [[xmlSaveData]] <br>
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]

= Syntax =
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
bool xmlSaveData ( string fileName, table data [, bool serverProtected = true, bool encryptData = false, bool resourceProtected = false ] )
</syntaxhighlight>

<syntaxhighlight lang="lua">
bool xmlSaveData ( string fileName, table data [, int securityLevel = 4] )
</syntaxhighlight>

====Required Arguments====
*'''fileName:''' The name of the file you want to create
*'''data:''' The data you want to save (must be a table!)

====Optional Arguments====
*'''serverProtected:''' If set to ''true'' the script will protect the file so, that can only the creator server can access it.'''
*'''encryptData:''' If set to ''true'' the script will generate a random key and use it to encrypt your stored data. '''Note: If you want to store "sensitive data", always use encryption!'''
*'''resourceProtected:''' If set to ''true'' the script will add the sourceResource name (so the name of the resource from which it got called) to the fileName, preventing it from getting read/overwritten/deleted by any other resource. If set to ''false'' you can use this script to call/send/modify tables from different resources without the use of events/other export functions.
or
*'''securityLevel:''' The level of security on which you want to store your data at. (Details on the resource page: [https://wiki.multitheftauto.com/wiki/XmlData#Security_Levels Security Levels])

'''See [https://wiki.multitheftauto.com/wiki/XmlData#Variables_and_Specified_Names xmlData Variables and Specified names] for more detail.'''

===Returns===
Returns ''true'' if successful, ''false'' otherwise.
</section>

<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
bool xmlSaveData ( string fileName, table data [, bool encryptData = false, bool resourceProtected = false ] )
</syntaxhighlight>

<syntaxhighlight lang="lua">
bool xmlSaveData ( string fileName, table data [, int securityLevel = 4] )
</syntaxhighlight>

====Required Arguments====
*'''fileName:''' The name of the file you want to create
*'''data:''' The data you want to save (must be a table!)

====Optional Arguments====
*'''encryptData:''' If set to ''true'' the script will generate a random key and use it to encrypt your stored data. '''Note: If you want to store "sensitive data", always use encryption! (Account data should never be stored in serverside files - use a database instead!)'''
*'''resourceProtected:''' If set to ''true'' the script will add the sourceResource name (so the name of the resource from which it got called) to the fileName, preventing it from getting read/overwritten/deleted by any other resource. If set to ''false'' you can use this script to call/send/modify tables from different resources without the use of events/other export functions.
or
*'''securityLevel:''' The level of security on which you want to store your data at. (Details on the resource page: [https://wiki.multitheftauto.com/wiki/XmlData#Security_Levels Security Levels])

'''See [https://wiki.multitheftauto.com/wiki/XmlData#Variables_and_Specified_Names xmlData Variables and Specified names] for more detail.'''

===Returns===
Returns ''true'' if successful, ''false'' otherwise.
</section>

== Example ==
<section name="Client" class="client" show="true">
This is the script where we specify the export shortcut and the data table which we want to store.
<syntaxhighlight lang="lua">
local xml = exports.xmlData
local tblScriptSettings = {posX = 800, posY = 500, sizeX = 500, sizeY = 300, settings = {show = true, tab = 1}}

xml:xmlSaveData("myFileName", tblScriptSettings , true, true) -- Save the data as "myFileName"
</syntaxhighlight>

This will create a server-protected, encrypted file on the clients computer called "myFileName.xml". Also it will generate a random generated key and stores it.<br>
The created file will -(could, because encrypted with a random key)- like this:

<syntaxhighlight lang="xml">
<root posY="VgEN0+TERhg=" posX="mjX4Tj5u6oM=" sizeX="VgEN0+TERhg=" sizeY="htgOMaZurQQ=">
<settings show="yeiNs/ne1Ks=" tab="OpijtdPvYqQ="></settings>
</root>
</syntaxhighlight>
</section>

==See Also==
{{XML_functions}}

[[Category:Useful Functions]]

2019-09-12T18:26:18Z

Ceeser:

2019-09-12T17:53:42Z

Ceeser:

<pageclass class="#228B22" subcaption="Useful Function - Shared"></pageclass>
<lowercasetitle></lowercasetitle>
<includeonly>
[[Category:Useful Functions]]
</includeonly>

{{Important Note|
This is an unofficial MTA function, so its not included into the game by default.<br>
Its an exported function of the [[xmlData]] resource.<br>
To access this function you need to have the resource running on your server.}}

This function provides an automated way of loading your data from an [[XML]] file created by [[xmlSaveData]] <br>
To call this function, see the [[call]] function or the tip in this resources page: [https://wiki.multitheftauto.com/wiki/XmlData#Simplifying_the_export Simplifying the export]

= Info =
'''If you used [[xmlSaveData]] with passing the securityLevel I recommend to pick securityLevel as function argument here as well.'''
'''For proper data loading you need to pass the same booleans/securityLevel as you did on xmlSaveData.'''

= Syntax =
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
bool xmlLoadData ( fileName [, serverProtected, resourceProtected ] )
bool xmlLoadData ( fileName [, int securityLevel] )
</syntaxhighlight>

<syntaxhighlight lang="lua">
bool xmlSaveData ( string fileName, table data [, int securityLevel = 4] )
</syntaxhighlight>

====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 created by the same server, otherwise it doesn't care which server created it.
*'''resourceProtected:''' If set to ''true'' it can only read the file created by the caller-resource
or
*'''securityLevel:''' The level of security on which you want to store your data at. (Details on the resource page: [https://wiki.multitheftauto.com/wiki/XmlData#Security_Levels Security Levels])

'''See [https://wiki.multitheftauto.com/wiki/XmlData#Variables_and_Specified_Names xmlData Variables and Specified names] for more detail.'''

===Returns===
Returns ''true'' if successful, ''false'' otherwise.

'''Note: There is no encryption parameter in this function, because xmlLoadData will load and use a files key if it is encrypted.'''
</section>

<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
bool xmlSaveData ( string fileName, table data [, bool encryptData = false, bool resourceProtected = false ] )
</syntaxhighlight>

<syntaxhighlight lang="lua">
bool xmlSaveData ( string fileName, table data [, int securityLevel = 4] )
</syntaxhighlight>

====Required Arguments====
*'''fileName:''' The name of the file you want to create

====Optional Arguments====
*'''encryptData:''' If set to ''true'' the script will generate a random key and use it to encrypt your stored data. '''Note: If you want to store "sensitive data", always use encryption! (Account data should never be stored in serverside files - use a database instead!)'''
*'''resourceProtected:''' If set to ''true'' the script will add the sourceResource name (so the name of the resource from which it got called) to the fileName, preventing it from getting read/overwritten/deleted by any other resource. If set to ''false'' you can use this script to call/send/modify tables from different resources without the use of events/other export functions.
or
*'''securityLevel:''' The level of security on which you want to store your data at. (Details on the resource page: [https://wiki.multitheftauto.com/wiki/XmlData#Security_Levels Security Levels])

'''See [https://wiki.multitheftauto.com/wiki/XmlData#Variables_and_Specified_Names xmlData Variables and Specified names] for more detail.'''

===Returns===
Returns ''true'' if successful, ''false'' otherwise.

'''Note: There is no encryption parameter in this function, because xmlLoadData will load and use a files key if it is encrypted.'''
</section>

== Example ==
<section name="Client" class="client" show="true">
This is the script where we specify the export shortcut and the data table which we want to store.
<syntaxhighlight lang="lua">
local xml = exports.xmlData
local tblScriptSettings = {posX = 800, posY = 500, sizeX = 500, sizeY = 300, settings = {show = true, tab = 1}}

xml:xmlSaveData("myFileName", tblScriptSettings , true, true) -- Save the data as "myFileName"
</syntaxhighlight>

This will create a server-protected, encrypted file on the clients computer called "myFileName.xml". Also it will generate a random generated key and stores it.<br>
The created file will -(could, because encrypted with a random key)- like this:

<syntaxhighlight lang="xml">
<root posY="VgEN0+TERhg=" posX="mjX4Tj5u6oM=" sizeX="VgEN0+TERhg=" sizeY="htgOMaZurQQ=">
<settings show="yeiNs/ne1Ks=" tab="OpijtdPvYqQ="></settings>
</root>
</syntaxhighlight>
</section>