Multi Theft Auto: Wiki - User contributions [en]

SetElementData

2011-08-19T16:58:07Z

William da silva:

{{Server client function}}
__NOTOC__
This function stores [[element data]] under a certain key, attached to an element. Element data set using this is then synced with all clients or the server. As such you should avoid passing data that is not able to be synced into this function (i.e. xmlnodes, acls, aclgroups etc.) Server-created elements are able to be synced.

==Syntax==

<syntaxhighlight lang="lua">
bool setElementData ( element theElement, string key, var value, [bool synchronize = true] )
</syntaxhighlight>

===Required Arguments===
*'''theElement:''' The [[element]] you wish to attach the data to.
*'''key:''' The key you wish to store the data under. (Maximum 31 characters.)
*'''value:''' The value you wish to store. See [[element data]] for a list of acceptable datatypes.

===Optional Arguments===
*'''synchronize:''' Determines whether or not the data will be synchronized with the server (client-side variation) and remote clients (both variations).

===Returns===
Returns ''true'' if the data was set succesfully, ''false'' otherwise.

==Example==
<section name="Server" class="server" show="true">
This example allows for a player to add a custom tag onto their nickname, and also revert it back to normal if they wish
<syntaxhighlight lang="lua">
function addPlayerCustomTag ( thePlayer, command, newTag )
--Let's make sure the newTag param has been entered...
if ( newTag ) then
--Grab their current playername for saving.
local sPlayerNickname = getPlayerName ( thePlayer )
--Create their new nickname with their tag
local sNewPlayerNickname = newTag .. " " .. sPlayerNickname

--Let's first load the element data, see if it's there already
--The reason for this is that if a player were to do /addtag twice,
--the tag would be prepended a second time
local sOldNick = getElementData( thePlayer, "tempdata.originalnick" )
if ( sOldNick == false ) then
--Save their orignal nickname in their element data
setElementData ( thePlayer, "tempdata.originalnick", sPlayerNickname )
end

--Set their new nickname globally
setPlayerName ( thePlayer, sNewPlayerNickname )

--Tell them it's done
outputChatBox ( "Your new nickname has been set, to put it back to its original state you can use /deltag", thePlayer )
else
--The newTag param was not entered, give an error message
outputChatBox ( "/addtag - Incorrect syntax, Correct: /addtag <newtag>", thePlayer )
end
end
addCommandHandler ( "addtag", addPlayerCustomTag )

function removePlayerCustomTag ( thePlayer, command )
--We first need to check that they have already used /addtag, let's do that now
local sOldNick = getElementData( thePlayer, "tempdata.originalnick" )
if ( sOldNick ) then
--Great, they have a tag added, let's reset them

--First we will want to reset the element data back to its default (that being false)
setElementData ( thePlayer, "tempdata.originalnick", false )

--Now set the client name back
setClientName ( thePlayer, sOldNick )

--Notify them
outputChatBox ( "Your old nickname has been set", thePlayer )
end
end
addCommandHandler ( "deltag", removePlayerCustomTag )
</syntaxhighlight>
</section>

==See Also==
{{Element_functions}}

SetElementData

2011-08-19T16:57:43Z

William da silva:

Fr/Meta.xml

2011-08-19T16:37:16Z

William da silva:

Le ficher ''meta.xml'' presents MTA with a set of metadata, such as the resource's name, the scripts to include, and which files to precache for sending to clients among other things. It is also the scope of "elements". It is written in XML, which is based on HTML and is the parent of XHTML.

Note: Vous pouvez essayer le generateur de Meta.xml crée par 50p: http://forum.mtasa.com/viewtopic.php?f=91&t=22247

=Tags=
XML is a textual data format which is widely used for the representation of data. MTA uses an XML-based language to describe the metadata for resources by using the tags below:

*'''<info />''' Information about this resource, possible parameters include (any arbitrary parameters can be used and read using [[getResourceInfo]]):
** '''author:''' L'auteur de la ressource
** '''version:''' La version de la ressource
** '''name:''' Le nom de la ressource
** '''description:''' Une petite description de la ressource
** '''type:''' Le type de ressource, ça peut être "gamemode", "script", "map" ou "misc".
*'''<script />''' Le code source de la ressource, les paramètres possibles sont:
** '''src:''' Le nom du fichier
** '''type:''' Le type du code source: "client" ou "server"
*'''<map />''' La map pour le gamemode, les paramètres possibles sont:
**'''src:''' Nom du fichier .map (Peut être distant. "maps/filename.map")
*'''<file />''' A client-side file. Generally these are images, .txd, .col, .dff or .xml files. They'll be downloaded by clients when the resources is started (or on join)
**'''src:''' client-side file name (can be path too eg. "images/image.png")
*'''<include />''' Include resources that this resource will use
**'''resource:''' Resource name that you want to start with this resource
**'''minversion:''' Minimum version that '''resource''' needs to be (optional)
**'''maxversion:''' Maximum version that '''resource''' needs to be (optional)
*'''<config />''' Config file (.xml) can be accessed by resource, possible parameters are:
**'''src:''' The file name of the config file
**'''type:''' The type of the config file: "client" or "server"
*'''<export />''' This exports functions from this resource, so other resources can use them with [[call]]
**'''function:''' The function name
**'''type''' Whether function is exported server-side or client-side (valid values are: "server" and "client")
**'''http:''' Can the function be called via HTTP (true/false)
*'''<html />'''
**'''src:''' The filename for the HTTP file (can be a path)
**'''default:''' The html file is one that is shown by default when visiting /resourceName/ on the server. Only one html can be default, the rest are ignored. (true/false)
**'''raw:''' The html file is not parsed by the LUA interpreter and is treated as binary data. Must be used for binary files (images mainly) (true/false)
*'''<settings> <setting name="" value=""/> </settings>:''' Most gamemodes use [[settings system]] to let server admins to configure it how they like. For instance you could set round time and then use [[get]] and [[set]] to get the value or change it, respectively.

== Example ==
Heres an example of a meta file using some of the tags mentioned:
<syntaxhighlight lang="lua" lang="xml"><meta>
<info author="Slothman" type="gamemode" name="Stealth" />
<config src="help.xml" type="client"/>

<script src="stealthmain_server.lua" />
<script src="noiseblip.lua" />
<script src="mission_timer.lua" />
<script src="gadgets_server.lua" />
<script src="gadgets_client.lua" type="client"/>
<script src="stealthmain_client.lua" type="client"/>
<script src="noisebar.lua" type="client"/>
<script src="spycam.lua" type="client"/>

<file src="riot_shield.txd" />
<file src="riot_shield.dff" />
<file src="riot_shield.col" />
<file src="armor.png" />
<file src="camera.png" />
<file src="cloak.png" />
<file src="goggles.png" />
<file src="mine.png" />
<file src="radar.png" />
<file src="shield.png" />

<include resource="scoreboard" />
<include resource="killmessages" />
<include resource="maplimits" />

<settings>
<setting name="roundlimit" value="[6]" /> 
<setting name="teamdamage" value="[1]" /> 
<setting name="teambalance" value="[1]" /> 
<setting name="spazammo" value="[25]" /> 
<setting name="m4ammo" value="[100]" />
<setting name="shotgunammo" value="[25]" />
<setting name="sniperammo" value="[20]" />
<setting name="ak47ammo" value="[120]" />
<setting name="rifleammo" value="[40]" />
<setting name="deserteagleammo" value="[45]" />
<setting name="pistolammo" value="[132]" />
<setting name="uziammo" value="[150]" />
<setting name="tec9ammo" value="[150]" />
<setting name="silencedammo" value="[65]" />
<setting name="grenadeammo" value="[4]" />
<setting name="satchelammo" value="[4]" />
<setting name="teargasammo" value="[4]" />
<setting name="molatovammo" value="[4]" />
</settings>
</meta></syntaxhighlight>
[[Category:Scripting Concepts]]
[[ru:Meta.xml]]

Fr/Meta.xml

2011-08-19T16:25:32Z

William da silva: Created page with "Le ficher ''meta.xml'' presents MTA with a set of metadata, such as the resource's name, the scripts to include, and which files to precache for sending to clients among other th..."

Le ficher ''meta.xml'' presents MTA with a set of metadata, such as the resource's name, the scripts to include, and which files to precache for sending to clients among other things. It is also the scope of "elements". It is written in XML, which is based on HTML and is the parent of XHTML.

Note: Vous pouvez essayer le generateur de Meta.xml crée par 50p: http://forum.mtasa.com/viewtopic.php?f=91&t=22247

=Tags=
XML is a textual data format which is widely used for the representation of data. MTA uses an XML-based language to describe the metadata for resources by using the tags below:

*'''<info />''' Information about this resource, possible parameters include (any arbitrary parameters can be used and read using [[getResourceInfo]]):
** '''author:''' The author of this resource
** '''version:''' The version of this resource
** '''name:''' The name of this resource
** '''description:''' A brief description of this resource
** '''type:''' The type of this resource, that can be "gamemode", "script", "map" or "misc".
*'''<script />''' Source code for this resource, possible parameters are:
** '''src:''' The file name of the source code
** '''type:''' The type of source code: "client" or "server"
*'''<map />''' The map for a gamemode, possible parameters are:
**'''src:''' .map file name (can be path too eg. "maps/filename.map")
**'''dimension:''' Dimension in which the map will be loaded (optional)
*'''<file />''' A client-side file. Generally these are images, .txd, .col, .dff or .xml files. They'll be downloaded by clients when the resources is started (or on join)
**'''src:''' client-side file name (can be path too eg. "images/image.png")
*'''<include />''' Include resources that this resource will use
**'''resource:''' Resource name that you want to start with this resource
**'''minversion:''' Minimum version that '''resource''' needs to be (optional)
**'''maxversion:''' Maximum version that '''resource''' needs to be (optional)
*'''<config />''' Config file (.xml) can be accessed by resource, possible parameters are:
**'''src:''' The file name of the config file
**'''type:''' The type of the config file: "client" or "server"
*'''<export />''' This exports functions from this resource, so other resources can use them with [[call]]
**'''function:''' The function name
**'''type''' Whether function is exported server-side or client-side (valid values are: "server" and "client")
**'''http:''' Can the function be called via HTTP (true/false)
*'''<html />'''
**'''src:''' The filename for the HTTP file (can be a path)
**'''default:''' The html file is one that is shown by default when visiting /resourceName/ on the server. Only one html can be default, the rest are ignored. (true/false)
**'''raw:''' The html file is not parsed by the LUA interpreter and is treated as binary data. Must be used for binary files (images mainly) (true/false)
*'''<settings> <setting name="" value=""/> </settings>:''' Most gamemodes use [[settings system]] to let server admins to configure it how they like. For instance you could set round time and then use [[get]] and [[set]] to get the value or change it, respectively.

== Example ==
Heres an example of a meta file using some of the tags mentioned:
<syntaxhighlight lang="lua" lang="xml"><meta>
<info author="Slothman" type="gamemode" name="Stealth" />
<config src="help.xml" type="client"/>

<script src="stealthmain_server.lua" />
<script src="noiseblip.lua" />
<script src="mission_timer.lua" />
<script src="gadgets_server.lua" />
<script src="gadgets_client.lua" type="client"/>
<script src="stealthmain_client.lua" type="client"/>
<script src="noisebar.lua" type="client"/>
<script src="spycam.lua" type="client"/>

<file src="riot_shield.txd" />
<file src="riot_shield.dff" />
<file src="riot_shield.col" />
<file src="armor.png" />
<file src="camera.png" />
<file src="cloak.png" />
<file src="goggles.png" />
<file src="mine.png" />
<file src="radar.png" />
<file src="shield.png" />

<include resource="scoreboard" />
<include resource="killmessages" />
<include resource="maplimits" />

<settings>
<setting name="roundlimit" value="[6]" /> 
<setting name="teamdamage" value="[1]" /> 
<setting name="teambalance" value="[1]" /> 
<setting name="spazammo" value="[25]" /> 
<setting name="m4ammo" value="[100]" />
<setting name="shotgunammo" value="[25]" />
<setting name="sniperammo" value="[20]" />
<setting name="ak47ammo" value="[120]" />
<setting name="rifleammo" value="[40]" />
<setting name="deserteagleammo" value="[45]" />
<setting name="pistolammo" value="[132]" />
<setting name="uziammo" value="[150]" />
<setting name="tec9ammo" value="[150]" />
<setting name="silencedammo" value="[65]" />
<setting name="grenadeammo" value="[4]" />
<setting name="satchelammo" value="[4]" />
<setting name="teargasammo" value="[4]" />
<setting name="molatovammo" value="[4]" />
</settings>
</meta></syntaxhighlight>
[[Category:Scripting Concepts]]
[[ru:Meta.xml]]