GetAllElementData: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (→‎Syntax: OOP)
m (fixed example)
Line 22: Line 22:
     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

Revision as of 16:00, 20 August 2014

Returns a table of all element data of an element.

Syntax

table getAllElementData ( element theElement )

OOP Syntax Help! I don't understand this!

Note: This function is also a static function underneath the Element class.
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