GetUserdataType - Revision history

Tracer: Fixed a markup typo

2023-03-02T17:53:01Z

Fixed a markup typo

← Older revision		Revision as of 17:53, 2 March 2023
Line 20:		Line 20:
	***''request'': a userdata type returned via [[fetchRemote]] (since [https://buildinfo.mtasa.com/?Revision=21436&Branch= r21436])		***''request'': a userdata type returned via [[fetchRemote]] (since [https://buildinfo.mtasa.com/?Revision=21436&Branch= r21436])
	***''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'''		**'''Server only'''
	***''account'': a [[Account\|player account]].		***''account'': a [[Account\|player account]].

LopSided at 21:42, 5 December 2022

2022-12-05T21:42:10Z

← Older revision		Revision as of 21:42, 5 December 2022
Line 18:		Line 18:
	***''vector4'': a 4D vector, used in the [[Vector/Vector4\|Vector4]] class.		***''vector4'': a 4D vector, used in the [[Vector/Vector4\|Vector4]] class.
	***''matrix'': a matrix, used in the [[Matrix]] class.		***''matrix'': a matrix, used in the [[Matrix]] class.
	***''request'': a userdata type returned via [[fetchRemote]]		***''request'': a userdata type returned via [[fetchRemote]] (since [https://buildinfo.mtasa.com/?Revision=21436&Branch= r21436])
	***''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.

LopSided at 18:34, 5 December 2022

2022-12-05T18:34:10Z

← Older revision		Revision as of 18:34, 5 December 2022
Line 18:		Line 18:
	***''vector4'': a 4D vector, used in the [[Vector/Vector4\|Vector4]] class.		***''vector4'': a 4D vector, used in the [[Vector/Vector4\|Vector4]] class.
	***''matrix'': a matrix, used in the [[Matrix]] class.		***''matrix'': a matrix, used in the [[Matrix]] class.
			***''request'': a userdata type returned via [[fetchRemote]]
	***''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.
	***''request'': a request userdata type returned via [[fetchRemote]]
	**'''Server only'''		**'''Server only'''
	***''account'': a [[Account\|player account]].		***''account'': a [[Account\|player account]].

LopSided: Add type for CRemoteCall (fetchRemote)

2022-12-05T18:33:34Z

Add type for CRemoteCall (fetchRemote)

← Older revision		Revision as of 18:33, 5 December 2022
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.
			***''request'': a request userdata type returned via [[fetchRemote]]
	**'''Server only'''		**'''Server only'''
	***''account'': a [[Account\|player account]].		***''account'': a [[Account\|player account]].

AlexTMjugador at 15:35, 16 October 2016

2016-10-16T15:35:19Z

← Older revision		Revision as of 15:35, 16 October 2016
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server client function}}		{{Server client function}}
	{{New feature/item\|3.~~0160~~\|1.6\|9768\|This function gets the type of a userdata value, which is not always a [[element]] in the element tree.}}		{{New feature/item\|3.0153\|1.5.3\|9768\|This function gets the type of a userdata value, which is not always a [[element]] in the element tree.}}

	==Syntax==		==Syntax==

Qaisjp: decaps

2016-08-05T02:41:20Z

decaps

← Older revision		Revision as of 02:41, 5 August 2016
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~~'''		**'''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~~'''		**'''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]].

AlexTMjugador at 15:45, 30 July 2016

2016-07-30T15:45:14Z

← Older revision		Revision as of 15:45, 30 July 2016
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]].

AlexTMjugador: Typo at /* Example */

2016-07-30T15:42:19Z

Typo at Example

← Older revision		Revision as of 15:42, 30 July 2016
Line 47:		Line 47:
	arg:getX(),		arg:getX(),
	arg:getY(),		arg:getY(),
	arg.getZ and ~~argValue~~:getZ() or nil,		arg.getZ and arg:getZ() or nil,
	arg.getW and ~~argValue~~:getW() or nil,		arg.getW and arg:getW() or nil,
	-- Extra field to distinguish from normal tables		-- Extra field to distinguish from normal tables
	["isVectorWorkaround"] = true		["isVectorWorkaround"] = true

AlexTMjugador: Documented the function

2016-07-30T15:40:49Z

Documented the function

New page

__NOTOC__
{{Server client function}}
{{New feature/item|3.0160|1.6|9768|This function gets the type of a userdata value, which is not always a [[element]] in the element tree.}}

==Syntax==
<syntaxhighlight lang="lua">
string getUserdataType ( userdata value )
</syntaxhighlight>

===Required Arguments===
*'''value''': A userdata value to get the type of. Userdata types can be:
**'''SHARED USERDATA TYPES'''
***''resource-data'': a [[Resource|resource pointer]].
***''xml-node'': a [[Xmlnode|XML node]].
***''lua-timer'': a [[timer]].
***''vector2'': a 2D vector, used in the [[Vector/Vector2|Vector2]] class.
***''vector3'': a 3D vector, used in the [[Vector/Vector3|Vector3]] class.
***''vector4'': a 4D vector, used in the [[Vector/Vector4|Vector4]] 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.
**'''SERVER ONLY USERDATA TYPES'''
***''account'': a [[Account|player account]].
***''db-query'': a [[dbQuery|database query handle]].
***''acl'': an [[ACL|ACL entry]].
***''acl-group'': an [[Aclgroup|ACL group]].
***''ban'': a [[Ban|player ban]].
***''text-item'': a [[Textitem|text display item]].
***''text-display'': a [[Textdisplay|text display item]].


===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.
<syntaxhighlight lang="lua">
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 argValue:getZ() or nil,
arg.getW and argValue:getW() or nil,
-- Extra field to distinguish from normal tables
["isVectorWorkaround"] = true
}
end
end
return unpack(args)
end
</syntaxhighlight>

==See Also==
{{Utility_functions}}