XmlLoadData: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 14: Line 14:
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]
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 =
= Syntax =
Line 33: Line 36:
*'''resourceProtected:''' If set to ''true'' it can only read the file created by the caller-resource
*'''resourceProtected:''' If set to ''true'' it can only read the file created by the caller-resource
or
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]
*'''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 Variables and Specified names] for more detail.'''
'''See [https://wiki.multitheftauto.com/wiki/XmlData#Variables_and_Specified_Names xmlData Variables and Specified names] for more detail.'''


===Returns===
===Returns===
Line 59: Line 62:
*'''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.
*'''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
or
*'''securityLevel:''' The level of security on which you want to store your data at. (See security levels here: [[XmlData#Security_Levels]]
*'''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===

Revision as of 17:53, 12 September 2019


[[{{{image}}}|link=|]] Important Note:

This is an unofficial MTA function, so its not included into the game by default.
Its an exported function of the xmlData resource.
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
To call this function, see the call function or the tip in this resources page: 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

Click to collapse [-]
Client
bool xmlLoadData ( fileName [, serverProtected, resourceProtected ] )
bool xmlLoadData ( 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

  • 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: Security Levels)

See 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.

Click to collapse [-]
Server
bool xmlSaveData ( string fileName, table data [, bool encryptData = false, bool resourceProtected = false ] )
bool xmlSaveData ( string fileName, table data [, int securityLevel = 4] )

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: Security Levels)

See 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.


Example

Click to collapse [-]
Client

This is the script where we specify the export shortcut and the data table which we want to store.

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"

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.
The created file will -(could, because encrypted with a random key)- like this:

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