GetElementSpeed - Revision history

Alex7202 at 10:43, 3 June 2020

2020-06-03T10:43:20Z

← Older revision		Revision as of 10:43, 3 June 2020
Line 64:		Line 64:
	==See also==		==See also==
	{{Useful_Functions}}		{{Useful_Functions}}
			[[ru:getElementSpeed]]

Hiroko: Example now works if copy & pasted

2017-09-21T19:47:53Z

Example now works if copy & pasted

← Older revision		Revision as of 19:47, 21 September 2017
Line 52:		Line 52:
	local sx = guiGetScreenSize()		local sx = guiGetScreenSize()
	local function drawSpeed()		local function drawSpeed()
	local speedms, speedkmh, speedmph = getElementSpeed(~~localPlayer~~), getElementSpeed(~~localPlayer~~, 1), getElementSpeed(~~localPlayer~~, 2)		local vehicle = getPedOccupiedVehicle(getLocalPlayer())
			local speedms, speedkmh, speedmph = getElementSpeed(vehicle), getElementSpeed(vehicle, 1), getElementSpeed(vehicle, 2)
	local roundedSpeedms, roundedSpeedkmh, roundedSpeedmph = math.floor(speedms) == speedms and speedms or string.format(speedms, "%.1f"), math.floor(speedkmh) == speedkmh and speedkmh or string.format(speedkmh, "%.1f"), math.floor(speedmph) == speedmph and speedmph or string.format(speedmph, "%.1f")		local roundedSpeedms, roundedSpeedkmh, roundedSpeedmph = math.floor(speedms) == speedms and speedms or string.format(speedms, "%.1f"), math.floor(speedkmh) == speedkmh and speedkmh or string.format(speedkmh, "%.1f"), math.floor(speedmph) == speedmph and speedmph or string.format(speedmph, "%.1f")
	local speedoText = "Current speed: " .. roundedSpeedms .. " m/s \| " .. roundedSpeedkmh .. " km/h \| " .. roundedSpeedmph .. " mph"		local speedoText = "Current speed: " .. roundedSpeedms .. " m/s \| " .. roundedSpeedkmh .. " km/h \| " .. roundedSpeedmph .. " mph"
	dxDrawText(speedoText, sx - dxGetTextWidth(speedoText), 0)		dxDrawText(speedoText, sx - dxGetTextWidth(speedoText), 0)
	end		end
	addEventHandler("onClientPreRender", ~~root~~, drawSpeed)		addEventHandler("onClientPreRender", getRootElement(), drawSpeed)
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>

Skully: /* Optional arguments */

2017-09-14T13:51:19Z

Optional arguments

← Older revision		Revision as of 13:51, 14 September 2017
Line 18:		Line 18:
	===Optional arguments===		===Optional arguments===
	{{OptionalArg}}		{{OptionalArg}}
	* '''~~unit~~''': ~~the~~ unit of the speed returned. If not specified, the unit will be ''m/s''. It can be specified as a ''[[string]]'' or ''number'' as follows:		* '''Unit''': The unit of the speed returned. If not specified, the unit will be ''m/s''. It can be specified as a ''[[string]]'' or ''number'' as follows:
	** '''0''' or '''m/s''': meters per second (speed unit of the [http://en.wikipedia.org/wiki/International_System_of_Units International System of Units], used in formal contexts).		** '''0''' or '''m/s''': meters per second (speed unit of the [http://en.wikipedia.org/wiki/International_System_of_Units International System of Units], used in formal contexts).
	** '''1''' or '''km/h''': kilometres per hour (the most common speed unit, used in most countries).		** '''1''' or '''km/h''': kilometres per hour (the most common speed unit, used in most countries).

Skully: /* English improved. */

2017-09-14T13:50:00Z

English improved.

← Older revision		Revision as of 13:50, 14 September 2017
Line 48:		Line 48:
	==Example==		==Example==
	<section name="Clientside example" class="client" show="true">		<section name="Clientside example" class="client" show="true">
	This example draws the local player's speed rounded to a single decimal in the up-right corner of the screen in different units.		This example draws the local player's speed rounded to a single decimal in the top-right corner of the screen in different units.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	local sx = guiGetScreenSize()		local sx = guiGetScreenSize()

Skully: /* Code */

2017-09-14T13:49:02Z

Code

← Older revision		Revision as of 13:49, 14 September 2017
Line 28:		Line 28:
	==Code==		==Code==
	<section name="Function source" class="both" show="true">		<section name="Function source" class="both" show="true">
	'''~~This function requires~~ MTA: SA 1.4''' or higher to ~~work. It doesn't need, however, to activate ''~~OOP''.		'''It is recommended to use MTA:SA 1.4''' or higher with this function to use [[OOP]].
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function getElementSpeed(theElement, unit)		function getElementSpeed(theElement, unit)

Necktrox: Removed dots in list of compatible element types

2017-03-20T17:33:02Z

Removed dots in list of compatible element types

← Older revision		Revision as of 17:33, 20 March 2017
Line 10:		Line 10:
	===Required arguments===		===Required arguments===
	* '''theElement''': the [[element]] you want to get the speed of. Compatible [[element]] types are:		* '''theElement''': the [[element]] you want to get the speed of. Compatible [[element]] types are:
	** [[Player\|Players]].		** [[Player\|Players]]
	** [[Ped\|Peds]].		** [[Ped\|Peds]]
	** [[Object\|Objects]].		** [[Object\|Objects]]
	** [[Vehicle\|Vehicles]].		** [[Vehicle\|Vehicles]]
	** [[Projectile\|Projectiles]].		** [[Projectile\|Projectiles]]

	===Optional arguments===		===Optional arguments===

AlexTMjugador: Fixed some things at /* Code */

2017-03-20T13:00:09Z

Fixed some things at Code

← Older revision		Revision as of 13:00, 20 March 2017
Line 32:		Line 32:
	function getElementSpeed(theElement, unit)		function getElementSpeed(theElement, unit)
	-- Check arguments for errors		-- Check arguments for errors
	~~local theElementType = getElementType(theElement);~~
	assert(isElement(theElement), "Bad argument 1 @ getElementSpeed (element expected, got " .. type(theElement) .. ")")		assert(isElement(theElement), "Bad argument 1 @ getElementSpeed (element expected, got " .. type(theElement) .. ")")
	assert(~~theElementType~~ == "player" or ~~theElementType~~ == "ped" or ~~theElementType~~ == "object" or ~~theElementType~~ == "vehicle" or ~~theElementType~~ == "projectile", "Invalid element type @ getElementSpeed (player/ped/object/vehicle expected, got " .. ~~theElementType~~ .. ")")		local elementType = getElementType(theElement)
			assert(elementType == "player" or elementType == "ped" or elementType == "object" or elementType == "vehicle" or elementType == "projectile", "Invalid element type @ getElementSpeed (player/ped/object/vehicle/projectile expected, got " .. elementType .. ")")
	assert((unit == nil or type(unit) == "string" or type(unit) == "number") and (unit == nil or (tonumber(unit) and (tonumber(unit) == 0 or tonumber(unit) == 1 or tonumber(unit) == 2)) or unit == "m/s" or unit == "km/h" or unit == "mph"), "Bad argument 2 @ getElementSpeed (invalid speed unit)")		assert((unit == nil or type(unit) == "string" or type(unit) == "number") and (unit == nil or (tonumber(unit) and (tonumber(unit) == 0 or tonumber(unit) == 1 or tonumber(unit) == 2)) or unit == "m/s" or unit == "km/h" or unit == "mph"), "Bad argument 2 @ getElementSpeed (invalid speed unit)")
	-- Default to m/s if no unit specified and 'ignore' argument type if the string contains a number		-- Default to m/s if no unit specified and 'ignore' argument type if the string contains a number

AlexTMjugador: Added projectiles to the list of compatible element types

2017-03-20T12:58:30Z

Added projectiles to the list of compatible element types

← Older revision		Revision as of 12:58, 20 March 2017
Line 14:		Line 14:
	** [[Object\|Objects]].		** [[Object\|Objects]].
	** [[Vehicle\|Vehicles]].		** [[Vehicle\|Vehicles]].
			** [[Projectile\|Projectiles]].

	===Optional arguments===		===Optional arguments===

SalwadoR: Add support projectiles for function

2017-03-19T09:15:21Z

Add support projectiles for function

← Older revision		Revision as of 09:15, 19 March 2017
Line 31:		Line 31:
	function getElementSpeed(theElement, unit)		function getElementSpeed(theElement, unit)
	-- Check arguments for errors		-- Check arguments for errors
			local theElementType = getElementType(theElement);
	assert(isElement(theElement), "Bad argument 1 @ getElementSpeed (element expected, got " .. type(theElement) .. ")")		assert(isElement(theElement), "Bad argument 1 @ getElementSpeed (element expected, got " .. type(theElement) .. ")")
	assert(~~getElementType(theElement)~~ == "player" or ~~getElementType(theElement)~~ == "ped" or ~~getElementType(theElement)~~ == "object" or ~~getElementType(theElement)~~ == "vehicle", "Invalid element type @ getElementSpeed (player/ped/object/vehicle expected, got " .. ~~getElementType(theElement)~~ .. ")")		assert(theElementType == "player" or theElementType == "ped" or theElementType == "object" or theElementType == "vehicle" or theElementType == "projectile", "Invalid element type @ getElementSpeed (player/ped/object/vehicle expected, got " .. theElementType .. ")")
	assert((unit == nil or type(unit) == "string" or type(unit) == "number") and (unit == nil or (tonumber(unit) and (tonumber(unit) == 0 or tonumber(unit) == 1 or tonumber(unit) == 2)) or unit == "m/s" or unit == "km/h" or unit == "mph"), "Bad argument 2 @ getElementSpeed (invalid speed unit)")		assert((unit == nil or type(unit) == "string" or type(unit) == "number") and (unit == nil or (tonumber(unit) and (tonumber(unit) == 0 or tonumber(unit) == 1 or tonumber(unit) == 2)) or unit == "m/s" or unit == "km/h" or unit == "mph"), "Bad argument 2 @ getElementSpeed (invalid speed unit)")
	-- Default to m/s if no unit specified and 'ignore' argument type if the string contains a number		-- Default to m/s if no unit specified and 'ignore' argument type if the string contains a number

AlexTMjugador: Fixed some things at /* Code */

2015-02-09T18:46:56Z

Fixed some things at Code

← Older revision		Revision as of 18:46, 9 February 2015
Line 33:		Line 33:
	assert(isElement(theElement), "Bad argument 1 @ getElementSpeed (element expected, got " .. type(theElement) .. ")")		assert(isElement(theElement), "Bad argument 1 @ getElementSpeed (element expected, got " .. type(theElement) .. ")")
	assert(getElementType(theElement) == "player" or getElementType(theElement) == "ped" or getElementType(theElement) == "object" or getElementType(theElement) == "vehicle", "Invalid element type @ getElementSpeed (player/ped/object/vehicle expected, got " .. getElementType(theElement) .. ")")		assert(getElementType(theElement) == "player" or getElementType(theElement) == "ped" or getElementType(theElement) == "object" or getElementType(theElement) == "vehicle", "Invalid element type @ getElementSpeed (player/ped/object/vehicle expected, got " .. getElementType(theElement) .. ")")
	assert((unit == nil or type(unit) == "string" or type(unit) == "number") and ((tonumber(unit) and (tonumber(unit) == 0 or ~~unit ==~~ tonumber(unit) == 1 or tonumber(unit) == 2)) or unit == "m/s" or unit == "km/h" or unit == "mph"), "Bad argument 2 @ getElementSpeed (invalid speed unit)")		assert((unit == nil or type(unit) == "string" or type(unit) == "number") and (unit == nil or (tonumber(unit) and (tonumber(unit) == 0 or tonumber(unit) == 1 or tonumber(unit) == 2)) or unit == "m/s" or unit == "km/h" or unit == "mph"), "Bad argument 2 @ getElementSpeed (invalid speed unit)")
	-- Default to m/s if no unit specified and 'ignore' argument type if the string contains a number		-- Default to m/s if no unit specified and 'ignore' argument type if the string contains a number
	unit = unit == nil and 0 or ((not tonumber(unit)) and unit or tonumber(unit))		unit = unit == nil and 0 or ((not tonumber(unit)) and unit or tonumber(unit))
Line 39:		Line 39:
	local mult = (unit == 0 or unit == "m/s") and 50 or ((unit == 1 or unit == "km/h") and 180 or 111.84681456)		local mult = (unit == 0 or unit == "m/s") and 50 or ((unit == 1 or unit == "km/h") and 180 or 111.84681456)
	-- Return the speed by calculating the length of the velocity vector, after converting the velocity to the specified unit		-- Return the speed by calculating the length of the velocity vector, after converting the velocity to the specified unit
	return (Vector3~~.create~~(getElementVelocity(theElement)) * mult).length		return (Vector3(getElementVelocity(theElement)) * mult).length
	end		end
	</syntaxhighlight>		</syntaxhighlight>