GetElementSpeed

2017-09-21T19:47:53Z

Hiroko: Example now works if copy & pasted

__NOTOC__
{{Useful Function}}
This function returns the speed of an element in m/s, km/h or mph.

==Syntax==
<syntaxhighlight lang="lua">
float/nil getElementSpeed ( element theElement [, int/string unit="m/s" ] )
</syntaxhighlight>

===Required arguments===
* '''theElement''': the [[element]] you want to get the speed of. Compatible [[element]] types are:
** [[Player|Players]]
** [[Ped|Peds]]
** [[Object|Objects]]
** [[Vehicle|Vehicles]]
** [[Projectile|Projectiles]]

===Optional arguments===
{{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:
** '''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).
** '''2''' or '''mph''': miles per hour (used in some English-speaking countries).

==Returns==
This function returns a ''number'' containing the [[element]]'s speed if the arguments provided are valid. It returns ''[[nil]]'' plus an ''error'' otherwise.

==Code==
<section name="Function source" class="both" show="true">
'''It is recommended to use MTA:SA 1.4''' or higher with this function to use [[OOP]].
<syntaxhighlight lang="lua">
function getElementSpeed(theElement, unit)
-- Check arguments for errors
assert(isElement(theElement), "Bad argument 1 @ getElementSpeed (element expected, got " .. type(theElement) .. ")")
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)")
-- 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))
-- Setup our multiplier to convert the velocity to the specified unit
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 (Vector3(getElementVelocity(theElement)) * mult).length
end
</syntaxhighlight>
</section>

==Example==
<section name="Clientside example" class="client" show="true">
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">
local sx = guiGetScreenSize()
local function drawSpeed()
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 speedoText = "Current speed: " .. roundedSpeedms .. " m/s | " .. roundedSpeedkmh .. " km/h | " .. roundedSpeedmph .. " mph"
dxDrawText(speedoText, sx - dxGetTextWidth(speedoText), 0)
end
addEventHandler("onClientPreRender", getRootElement(), drawSpeed)
</syntaxhighlight>
</section>

==See also==
{{Useful_Functions}}

BitXor

2016-01-08T21:54:28Z

Hiroko: Example added

{{Server client function}}
__NOTOC__
{{New feature/item|3.0132|1.3.2|5340|
This function performs a bitwise XOR-conjunction (exclusive OR) on two or more (unsigned) 32-bit [[Int|integers]]. See [http://en.wikipedia.org/wiki/Bitwise_operation#XOR Bitwise operation] for more details.
}}

==Syntax==
<syntaxhighlight lang="lua">
uint bitXor ( uint var1, uint var2, ... )
</syntaxhighlight>

===Required arguments===
*'''varN:''' The value you want to perform a XOR-conjunction on

===Returns===
Returns the conjuncted value.

==Example==
This example will do a bitwise XOR of x1, x2, ...

<syntaxhighlight lang="lua">
local x1 = 0x14 -- binary: 0001 0100
local x2 = 0x1C -- binary: 0001 1100

bitXor(x1, x2) -- return 0000 1000
</syntaxhighlight>

==See Also==
{{Bit_functions}}

BitOr

2016-01-08T21:50:08Z

Hiroko: Example added

{{Server client function}}
__NOTOC__
{{New feature/item|3.0132|1.3.2|5340|
This function performs a bitwise OR-conjunction on two or more (unsigned) 32-bit [[Int|integers]]. See [http://en.wikipedia.org/wiki/Bitwise_operation#OR Bitwise operation] for more details.
}}

==Syntax==
<syntaxhighlight lang="lua">
uint bitOr ( uint var1, uint var2, ... )
</syntaxhighlight>

===Required arguments===
*'''varN:''' The value you want to perform an OR-conjunction on

===Returns===
Returns the conjuncted value.

==Example==
This example will do a bitwise OR of x1, x2, ...
<syntaxhighlight lang="lua">
local x1 = 0x31 -- binary: 0011 0001
local x2 = 0x19 -- binary: 0001 1001

bitOr(x1, x2) -- return 0011 1001
</syntaxhighlight>

==See Also==
{{Bit_functions}}

Multi Theft Auto: Wiki - User contributions [en]

GetElementSpeed

BitXor

BitOr