GetUserdataType: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (Typo at →‎Example)
mNo edit summary
Line 10: Line 10:
===Required Arguments===  
===Required Arguments===  
*'''value''': A userdata value to get the type of. Userdata types can be:
*'''value''': A userdata value to get the type of. Userdata types can be:
**'''SHARED USERDATA TYPES'''
**'''SHARED'''
***''resource-data'': a [[Resource|resource pointer]].
***''resource-data'': a [[Resource|resource pointer]].
***''xml-node'': a [[Xmlnode|XML node]].
***''xml-node'': a [[Xmlnode|XML node]].
Line 19: Line 19:
***''matrix'': a matrix, used in the [[Matrix]] class.
***''matrix'': a matrix, used in the [[Matrix]] class.
***''userdata'': a fallback userdata type return value, when no other type could be found for the object.
***''userdata'': a fallback userdata type return value, when no other type could be found for the object.
**'''SERVER ONLY USERDATA TYPES'''
**'''SERVER ONLY'''
***''account'': a [[Account|player account]].
***''account'': a [[Account|player account]].
***''db-query'': a [[dbQuery|database query handle]].
***''db-query'': a [[dbQuery|database query handle]].

Revision as of 15:45, 30 July 2016

This function gets the type of a userdata value, which is not always a element in the element tree.

Syntax

string getUserdataType ( userdata value )

Required Arguments

Returns

Returns a string containing the specified userdata's type, or false plus an error message if the given value is not userdata.

Example

This example shows a function that can be used to work around the impossibility to transfer vectors as arguments when using triggerClientEvent and triggerServerEvent, by converting them into a table which can be used safely.

function safeArgsForTransfer(...)
    local args = { ... }
    for index, arg in ipairs(args) do
        if type(arg) == "userdata" and getUserdataType(arg):match("vector") then
            -- Transform every kind of vector userdata to a table which can be transfered safely
            args[index] =
            {
                arg:getX(),
                arg:getY(),
                arg.getZ and arg:getZ() or nil,
                arg.getW and arg:getW() or nil,
                -- Extra field to distinguish from normal tables
                ["isVectorWorkaround"] = true
            }
        end
    end
    return unpack(args)
end

See Also