Resource:EntityData - Revision history

Saatanikk: /* getAllEntityData */

2022-01-20T10:51:06Z

getAllEntityData

← Older revision		Revision as of 10:51, 20 January 2022
Line 63:		Line 63:
	This function returns a table of all entity data of an element.		This function returns a table of all entity data of an element.

	<syntaxhighlight lang="lua">string exports.entityData:~~getAllEnintyData~~(element/table theElement, [string type="public"])</syntaxhighlight>		<syntaxhighlight lang="lua">string exports.entityData:getAllEntityData(element/table theElement, [string type="public"])</syntaxhighlight>
	===Required Arguments===		===Required Arguments===
	*'''element theElement:''' This is the element/elements with data you want to retrieve.		*'''element theElement:''' This is the element/elements with data you want to retrieve.

GalAnonim: /* triggerTransaction */

2021-11-26T14:11:50Z

triggerTransaction

← Older revision		Revision as of 14:11, 26 November 2021
Line 123:		Line 123:
	<syntaxhighlight lang="lua">string exports.entityData:triggerTransaction(int transaction/table transaction)</syntaxhighlight>		<syntaxhighlight lang="lua">string exports.entityData:triggerTransaction(int transaction/table transaction)</syntaxhighlight>
	===Required Arguments===		===Required Arguments===
	*'''int transaction:''' - The transaction number, if this value is provided, the data transfer will not be executed ~~immediately~~		*'''int transaction:''' - The transaction number, if this value is provided, the data transfer will not be executed
			*'''table transaction:''' - An table with the instruction to be executed to setEntityData

	===Returns===		===Returns===
	Returns true on valid transaction other than false		Returns true on valid transaction other than false
	</section>		</section>


	===cancelTransaction===		===cancelTransaction===

GalAnonim: /* createTransaction */

2021-11-26T14:10:03Z

createTransaction

← Older revision		Revision as of 14:10, 26 November 2021
Line 112:		Line 112:
	<section name="Shared" class="server" show="true">		<section name="Shared" class="server" show="true">
	This function creates instructions for the data transfer in the form of a transaction that must be accepted or canceled.		This function creates instructions for the data transfer in the form of a transaction that must be accepted or canceled.
	<syntaxhighlight lang="lua">~~boolean~~ exports.entityData:createTransaction()</syntaxhighlight>		<syntaxhighlight lang="lua">int exports.entityData:createTransaction()</syntaxhighlight>

	===Returns===		===Returns===

GalAnonim at 14:09, 26 November 2021

2021-11-26T14:09:33Z

@@ Line 82: / Line 82: @@
 This function checks if an element has entity data available under a certain key.
-<syntaxhighlight lang="lua">string exports.entityData:hasEntityData(element/table theElement, var/table key, [string type="public"])</syntaxhighlight>
+<syntaxhighlight lang="lua">boolean exports.entityData:hasEntityData(element/table theElement, var/table key, [string type="public"])</syntaxhighlight>
 ===Required Arguments===
 *'''element theElement:''' This is the element/elements with data you want to retrieve.
@@ Line 101: / Line 101: @@
 This function imposes restrictions on the key which, if not satisfied, will not perform the entity data assignment
-<syntaxhighlight lang="lua">string exports.entityData:setKeyFlag(var key, table flag)</syntaxhighlight>
+<syntaxhighlight lang="lua">boolean exports.entityData:setKeyFlag(var key, table flag)</syntaxhighlight>
 ===Required Arguments===
 *'''var key:''' The name of the entity data entry you want to check for.
@@ Line 107: / Line 107: @@
 ===Returns===
 Returns true if the flag is set and false if the flag is not set on the key.
 </section>

GalAnonim at 14:01, 26 November 2021

2021-11-26T14:01:42Z

← Older revision		Revision as of 14:01, 26 November 2021
Line 59:		Line 59:
	</section>		</section>

	===~~getAllEnintyData~~===		===getAllEntityData===
	<section name="Shared" class="server" show="true">		<section name="Shared" class="server" show="true">
	This function returns a table of all entity data of an element.		This function returns a table of all entity data of an element.

GalAnonim at 01:53, 26 November 2021

2021-11-26T01:53:26Z

← Older revision		Revision as of 01:53, 26 November 2021
Line 104:		Line 104:
	===Required Arguments===		===Required Arguments===
	*'''var key:''' The name of the entity data entry you want to check for.		*'''var key:''' The name of the entity data entry you want to check for.
	*'''table flag:''' A flag containing all the restrictions key.		*'''table flag:''' A flag containing all the [https://wiki.multitheftauto.com/wiki/Resource:EntityData/restrictions_key restrictions key]

	===Returns===		===Returns===
	Returns true if the flag is set and false if the flag is not set on the key.		Returns true if the flag is set and false if the flag is not set on the key.
	</section>		</section>

GalAnonim: Created page with "{{Resource page}}
'''Name''': entityData '''Developer''': User:GalAnonim (Rick) '''State''': OpenSource '''GitHub Source''': https://github.com/httpRick/entityData/tree/main '''Current Version''': 1.0.0
== Overview == The system of non-standard data operation for Elements on the MTA SA platform replaces ElementData ==Exporte..."

2021-11-26T01:16:24Z

Created page with "{{Resource page}} <div style="padding:10px; border-radius:2px;font-size:14px;"> '''Name''': entityData '''Developer''': User:GalAnonim (Rick) '''State''': <span style="color:#55FF55;text-shadow:black 0em 0em 0.3em;">OpenSource</span> '''GitHub Source''': https://github.com/httpRick/entityData/tree/main '''Current Version''': 1.0.0 </div> == Overview == The system of non-standard data operation for Elements on the MTA SA platform replaces ElementData ==Exporte..."

New page

{{Resource page}}
<div style="padding:10px; border-radius:2px;font-size:14px;">

'''Name''': entityData

'''Developer''': [[User:GalAnonim]] (Rick)

'''State''': <span style="color:#55FF55;text-shadow:black 0em 0em 0.3em;">OpenSource</span>

'''GitHub Source''': https://github.com/httpRick/entityData/tree/main

'''Current Version''': 1.0.0
</div>

== Overview ==
The system of non-standard data operation for Elements on the MTA SA platform replaces ElementData

==Exported functions==

===setEntityData===
This function passes user information about the element to entity Data, the data can be created by the server but you should avoid passing data from client to server when assigning.

<section name="Shared" class="server" show="true">
This function encrypts the data of the file
<syntaxhighlight lang="lua">string exports.entityData:setEntityData(element/table theElement, var/table key, var value, [string type="public", int transaction])</syntaxhighlight>
===Required Arguments===
*'''element theElement:''' The element/elements you wish to attach the data to.
*'''var key:''' The key/keys you wish to store the data under.

===Optional Arguments===
*'''string type:''' type of data synchronization
** ''"public"'' - Synchronizes between the server and the client, and between the client and the server (required to be enabled in the options)
** ''"local"'' - It does not synchronize, it remains on the side on which it was given
** ''"private"'' - Assigns and synchronizes one value for a given key for all items
*'''int transaction:''' - The transaction number, if this value is provided, the data transfer will not be executed immediately

===Returns===
Returns true if the data was set succesfully, false otherwise.
</section>

===getEntityData===
This function retrieves entity data attached to an element under a certain key.

<section name="Shared" class="server" show="true">
This function encrypts the data of the file
<syntaxhighlight lang="lua">string exports.entityData:getEntityData(element/table theElement, var/table key, [string type="public"])</syntaxhighlight>
===Required Arguments===
*'''element theElement:''' This is the element/elements with data you want to retrieve.
*'''var key:''' The name/names of the entity data entry you want to retrieve.

===Optional Arguments===
*'''string type:''' type of data synchronization
** ''"public"'' - Synchronizes between the server and the client, and between the client and the server (required to be enabled in the options)
** ''"local"'' - It does not synchronize, it remains on the side on which it was given
** ''"private"'' - Assigns and synchronizes one value for a given key for all items

===Returns===
This function returns a variable/tables containing the requested entity data, or false if the element/elements or the entity data does not exist.
</section>

===getAllEnintyData===
<section name="Shared" class="server" show="true">
This function returns a table of all entity data of an element.

<syntaxhighlight lang="lua">string exports.entityData:getAllEnintyData(element/table theElement, [string type="public"])</syntaxhighlight>
===Required Arguments===
*'''element theElement:''' This is the element/elements with data you want to retrieve.

===Optional Arguments===
*'''string type:''' type of data synchronization
** ''"public"''
** ''"local"''
** ''"private"''
** ''"all"''

===Returns===
If successful, returns a table with as keys the names of the entity data and as values the corresponding entity data values. Returns false in case of failure.
</section>

===hasEntityData===
<section name="Shared" class="server" show="true">
This function checks if an element has entity data available under a certain key.

<syntaxhighlight lang="lua">string exports.entityData:hasEntityData(element/table theElement, var/table key, [string type="public"])</syntaxhighlight>
===Required Arguments===
*'''element theElement:''' This is the element/elements with data you want to retrieve.
*'''var key:''' The name/names of the entity data entry you want to check for.

===Optional Arguments===
*'''string type:'''type of data synchronization
** ''"public"'' - Synchronizes between the server and the client, and between the client and the server (required to be enabled in the options)
** ''"local"'' - It does not synchronize, it remains on the side on which it was given
** ''"private"'' - Assigns and synchronizes one value for a given key for all items

===Returns===
This function returns true if the element contains entity data for key, or false if the element doesn't exist or there is no data associated with the key.
</section>

===setKeyFlag===
<section name="Shared" class="server" show="true">
This function imposes restrictions on the key which, if not satisfied, will not perform the entity data assignment

<syntaxhighlight lang="lua">string exports.entityData:setKeyFlag(var key, table flag)</syntaxhighlight>
===Required Arguments===
*'''var key:''' The name of the entity data entry you want to check for.
*'''table flag:''' A flag containing all the restrictions key.

===Returns===
Returns true if the flag is set and false if the flag is not set on the key.
</section>