GetAllElementData: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
(5 intermediate revisions by 4 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Server function}}
{{Shared function}}
 
{{New feature/item|3.0161|1.6.0|21695|Added also as a client-side function. Previously only available as a server-side function.}}


Returns a table of all element data of an element.
Returns a table of all element data of an element.
Line 8: Line 10:
table getAllElementData ( element theElement )
table getAllElementData ( element theElement )
</syntaxhighlight>
</syntaxhighlight>
{{OOP||[[element]]:getAllData||}}


===Required Arguments===
===Required Arguments===
Line 21: Line 24:
     local data = getAllElementData ( thePlayer )    -- get all the element data of the player who entered the command
     local data = getAllElementData ( thePlayer )    -- get all the element data of the player who entered the command
     for k, v in pairs ( data ) do                    -- loop through the table that was returned
     for k, v in pairs ( data ) do                    -- loop through the table that was returned
         outputConsole ( k .. ": " .. v )            -- print the name (k) and value (v) of each element data
         outputConsole ( k .. ": " .. tostring ( v ) )            -- print the name (k) and value (v) of each element data, we need to make the value a string, since it can be of any data type
     end
     end
end
end
Line 28: Line 31:


==See Also==
==See Also==
{{Element functions}}
{{Element functions|server}}

Latest revision as of 22:30, 6 September 2024

ADDED/UPDATED IN VERSION 1.6.0 r21695:
Added also as a client-side function. Previously only available as a server-side function.

Returns a table of all element data of an element.

Syntax

table getAllElementData ( element theElement )

OOP Syntax Help! I don't understand this!

Method: element:getAllData(...)


Required Arguments

  • theElement: the element you want to get the element data of.

Returns

If successful, returns a table with as keys the names of the element data and as values the corresponding element data values. Returns false in case of failure.

Example

This example script creates a new console command that displays all element data that is currently set on the player who enters the command. 

function getMyData ( thePlayer, command )
    local data = getAllElementData ( thePlayer )     -- get all the element data of the player who entered the command
    for k, v in pairs ( data ) do                    -- loop through the table that was returned
        outputConsole ( k .. ": " .. tostring ( v ) )             -- print the name (k) and value (v) of each element data, we need to make the value a string, since it can be of any data type
    end
end
addCommandHandler ( "elemdata", getMyData )

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/GetAllElementData?oldid=80357"