GetElementData: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
m (Added Portuguese BR to the sidebar)
 
(18 intermediate revisions by 16 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Server client function}}
{{Server client function}}
Elements can contain data values. These are accessable via names, and their value can be retrieved using [[getElementData]] and set using [[setElementData]]. These values are also loaded from the attributes in the XML map files, and as such can provide a powerful way to store and retrieve data in XML for each element.
This function retrieves [[element data]] attached to an element under a certain key.


==Syntax==
==Syntax==
<syntaxhighlight lang="lua">var getElementData ( element theElement, string key )</syntaxhighlight>
<syntaxhighlight lang="lua">var getElementData ( element theElement, string key [, bool inherit = true] )</syntaxhighlight>
{{OOP||[[element]]:getData||setElementData}}


===Required Arguments===
===Required Arguments===
*'''theElement:''' This is the element with data you want to retreive.
*'''theElement:''' This is the element with data you want to retrieve.
*'''key:''' The name of the element data entry you want to retrieve.
*'''key:''' The name of the element data entry you want to retrieve. (Maximum 31 characters.)
 
===Optional Arguments===
*'''inherit:''' - toggles whether or not the function should go up the hierarchy to find the requested key in case the specified element doesn't have it.


===Returns===
===Returns===
This function returns a ''variable'' containing the requested element data, or ''false'' if the element data does not exist, or the element itself does not exist. Usually this is a ''string'' but it doesn't have to be.
This function returns a ''variable'' containing the requested element data, or ''false'' if the element or the element data does not exist. When getting data corresponding to a XML attribute, this is always a ''string''.


==Example==
==Example==
'''Example 1:''' This example stores the tick count when a player joins and then allows players to see how long they are connected using a console function 'joinTime'.
This example stores the tick count when a player joins and then allows players to see how long they are connected using a console function 'joinTime'.
<section show="true" name="Server" class="server">
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function joinTime ( )
function joinTime ( )
Line 20: Line 25:
end
end
-- Make our 'joinTime' function be called when a player joins
-- Make our 'joinTime' function be called when a player joins
addEventHandler ( "onPlayerJoin", getRootElement(), joinTime )
addEventHandler ( "onPlayerJoin", root, joinTime )


function showJoinTime ( source, commandName, playerName )
function showJoinTime ( source, commandName, playerName )
    if ( playerName ) then -- see if a player was specified
if ( playerName ) then -- see if a player was specified
        thePlayer = getPlayerFromNick ( playerName ) -- get the player element for the specified player
thePlayer = getPlayerFromName ( playerName ) -- get the player element for the specified player
        if ( thePlayer ) then -- if one was found...
if ( thePlayer ) then -- if one was found...
local timeOnline = (getTickCount() - getElementData ( thePlayer, "joinTime" )) / 1000 -- calculates the time since join
local timeOnline = (getTickCount() - getElementData ( thePlayer, "joinTime" )) / 1000 -- calculates the time since join
            outputChatBox ( getClientName ( thePlayer ).." joined "..timeOnline.." seconds ago", source ) -- output the player's join time
outputChatBox ( getPlayerName ( thePlayer ).." joined "..timeOnline.." seconds ago", source ) -- output the player's join time
        else
else
            outputChatBox ( "Couldn't find '" .. playerName .. "'", source ) -- display an error
outputChatBox ( "Couldn't find '" .. playerName .. "'", source ) -- display an error
        end  
end
    else
else
        -- display when the player who used the function joined and inform how to see other people's join time
-- display when the player who used the function joined and inform how to see other people's join time
local timeOnline = (getTickCount() - getElementData ( source, "joinTime" )) / 1000 -- calculate the time since join
local timeOnline = (getTickCount() - getElementData ( source, "joinTime" )) / 1000 -- calculate the time since join
        outputChatBox ( "You joined " ..timeOnline.." seconds ago", source )
outputChatBox ( "You joined " ..timeOnline.." seconds ago", source )
        outputChatBox ( "Use 'join_time <player name>' to see other people's join time", source )
outputChatBox ( "Use 'join_time <player name>' to see other people's join time", source )
    end
end
end
end
-- Add a console command joinTime, that takes an optional parameter of a player's name
-- Add a console command joinTime, that takes an optional parameter of a player's name
addCommandHandler ( "joinTime", showJoinTime )
addCommandHandler ( "joinTime", showJoinTime )
</syntaxhighlight>
</syntaxhighlight>
<!--
</section>
'''Example 2:''' This example will store the version of the map in the variable ''mapVersion''. Generally this will be ''2.0'' in the final release.
 
<syntaxhighlight lang="lua">
map = getRootElement ( )
mapVersion = getElementData ( map, "version" )
</syntaxhighlight>
-->
==See Also==
==See Also==
{{Element functions}}
{{Element functions}}
[[pt-br:getElementData]]

Latest revision as of 18:35, 31 January 2022

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

Syntax

var getElementData ( element theElement, string key [, bool inherit = true] )

OOP Syntax Help! I don't understand this!

Method: element:getData(...)
Counterpart: setElementData


Required Arguments

  • theElement: This is the element with data you want to retrieve.
  • key: The name of the element data entry you want to retrieve. (Maximum 31 characters.)

Optional Arguments

  • inherit: - toggles whether or not the function should go up the hierarchy to find the requested key in case the specified element doesn't have it.

Returns

This function returns a variable containing the requested element data, or false if the element or the element data does not exist. When getting data corresponding to a XML attribute, this is always a string.

Example

This example stores the tick count when a player joins and then allows players to see how long they are connected using a console function 'joinTime'.

Click to collapse [-]
Server
function joinTime ( )
    setElementData ( source, "joinTime", getTickCount() ) -- Store the current tick count in the player's data with the key 'joinTime'
end
-- Make our 'joinTime' function be called when a player joins
addEventHandler ( "onPlayerJoin", root, joinTime )

function showJoinTime ( source, commandName, playerName )
	if ( playerName ) then -- see if a player was specified
		thePlayer = getPlayerFromName ( playerName ) -- get the player element for the specified player
		if ( thePlayer ) then -- if one was found...
			local timeOnline = (getTickCount() - getElementData ( thePlayer, "joinTime" )) / 1000 -- calculates the time since join
			outputChatBox ( getPlayerName ( thePlayer ).." joined "..timeOnline.." seconds ago", source ) -- output the player's join time
		else
			outputChatBox ( "Couldn't find '" .. playerName .. "'", source ) -- display an error
		end
	else
		-- display when the player who used the function joined and inform how to see other people's join time
		local timeOnline = (getTickCount() - getElementData ( source, "joinTime" )) / 1000 -- calculate the time since join
		outputChatBox ( "You joined " ..timeOnline.." seconds ago", source )
		outputChatBox ( "Use 'join_time <player name>' to see other people's join time", source )
	end
end
-- Add a console command joinTime, that takes an optional parameter of a player's name
addCommandHandler ( "joinTime", showJoinTime )

See Also

Retrieved from "https://wiki.multitheftauto.com/wiki/GetElementData?oldid=73938"