Multi Theft Auto: Wiki - User contributions [en]

GetElementSpeed

2017-03-19T09:15:21Z

SalwadoR: Add support projectiles for function

__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]].

===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">
'''This function requires MTA: SA 1.4''' or higher to work. It doesn't need, however, to activate ''OOP''.
<syntaxhighlight lang="lua">
function getElementSpeed(theElement, unit)
-- Check arguments for errors
local theElementType = getElementType(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 .. ")")
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 up-right corner of the screen in different units.
<syntaxhighlight lang="lua">
local sx = guiGetScreenSize()
local function drawSpeed()
local speedms, speedkmh, speedmph = getElementSpeed(localPlayer), getElementSpeed(localPlayer, 1), getElementSpeed(localPlayer, 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", root, drawSpeed)
</syntaxhighlight>
</section>

==See also==
{{Useful_Functions}}

User:SalwadoR

2016-11-21T16:35:52Z

SalwadoR:

ayy lmao

[[File:ayyy lmao.jpg]]

User:SalwadoR

2016-11-21T16:35:30Z

SalwadoR: Created page with "ayyy lmao File:ayyy lmao.jpg"

ayyy lmao

[[File:ayyy lmao.jpg]]

File:Ayyy lmao.jpg

2016-11-21T16:35:18Z

SalwadoR:

SetElementHealth

2016-11-21T16:31:13Z

SalwadoR:

{{Server client function}}
__NOTOC__
This function sets the health for the specified [[element]]. This can be a [[ped]], [[object]] or a [[vehicle]].

==Syntax==
<syntaxhighlight lang="lua">
bool setElementHealth ( element theElement, float newHealth )
</syntaxhighlight>
{{OOP||[[element]]:setHealth|health|getElementHealth}}

===Required Arguments===
*'''theElement:''' The [[ped]], [[vehicle]] or [[object]] whose health you want to set.
*'''newHealth:''' A float indicating the new health to set for the element.

===Returns===
Returns ''true'' if the new health was set successfully, or ''false'' if invalid arguments were passed.

==Example==
<section name="Server" class="server" show="true">
This example adds a 'hpslap' console command that lets players "slap" others (doing 20 damage).
<syntaxhighlight lang="lua">
function hpSlap ( sourcePlayer, command, targetPlayerName )
-- check if the user has access to it first
if not hasObjectPermissionTo(sourcePlayer, "command.slap", false) then
outputChatBox ( "You cannot use this command.", sourcePlayer )
return false
end
-- look up the player to be slapped
local targetPlayer = getPlayerFromName ( targetPlayerName )
-- if there's a player with such name,
if targetPlayer then
-- subtract 20 from his health
setElementHealth ( targetPlayer, getElementHealth(targetPlayer) - 20 )
else
-- otherwise, output an error message
outputChatBox ( "There is no player named " .. targetPlayerName .. "!", sourcePlayer )
end
end
-- add our function as a handler for "hpslap"
addCommandHandler ( "hpslap", hpSlap )
</syntaxhighlight>
</section>
<section name="Example 1" class="server" show="true">
This example setting health by a command.
<syntaxhighlight lang="lua">
function Health(player, command, amount)
setElementHealth(player, tonumber(amount))
end
addCommandHandler("set", Health)
</syntaxhighlight>
</section>

==See Also==
{{Element functions}}

GetLowLODElement

2016-11-16T13:08:46Z

SalwadoR: /* Example */

{{Needs_Example}}
__NOTOC__
{{Server client function}}
This function return the low LOD element that an element is associated with.

==Syntax==
<syntaxhighlight lang="lua">
element getLowLODElement ( element theElement )
</syntaxhighlight>
{{OOP||[[element]]:getLowLOD|lowLOD|setLowLODElement}}

===Required Arguments===
*'''theElement:''' The [[element]] whose low LOD version we want to get.

===Returns===
Returns a low LOD element if successful, ''false'' otherwise.

==Example==
<section name="Clientside example" class="client" show="true">
This example is not done yet:
<syntaxhighlight lang="lua">
local obj = createObject(1488,0,0,3,0,0,90) -- Create object
local lod_obj = createObject(1337,0,0,3,0,0,90,true) -- Create OD object

setLowLODElement(obj,lod_obj) -- Setting LOD, 'attach' to obj

local lod_get = getLowLODElement(obj) -- Get LOD from obj

--lod_get = lod_obj

</syntaxhighlight>
</section>

==Requirements==
{{Requirements|1.2|1.2}}
==See Also==
{{Element_functions}}

ToggleBrowserDevTools

2016-11-16T13:03:35Z

SalwadoR: /* Example */

__NOTOC__
{{Client function}}
{{New feature/item|3.0150|1.5||
This function toggles the visibility of the developer tools pane.
}}

==Syntax==
<syntaxhighlight lang="lua">
bool toggleBrowserDevTools ( browser webBrowser, bool visible )
</syntaxhighlight>
{{OOP||[[browser]]:toggleBrowserDevTools|devTools}}

===Required Arguments===
*'''webBrowser:''' The browser
*'''visible:''' ''true'' to show the tools, ''false'' to hide

===Returns===
Returns ''true'' if the visibility was successfully toggled, ''false'' if an error occurred

==Example==
This example will output browser console logs to debugscript.
<syntaxhighlight lang="lua">
local GUI_browser = guiCreateBrowser(100,100,640,480,false,false,false) -- Create Browser
local browser = guiGetBrowser(GUI_browser) -- Get browser from GUI element

setDevelopmentMode(false,true) -- Enable client dev.mode
toggleBrowserDevTools(browser,true) -- Its a magic =\
</syntaxhighlight>

==See also==
{{CEF_functions}}

GetBrowserTitle

2016-11-16T12:55:57Z

SalwadoR:

__NOTOC__
{{Client function}}
{{New feature/item|3.0150|1.5||
This function returns the title of the passed [[Element/Browser|browser]].
}}

==Syntax==
<syntaxhighlight lang="lua">
string getBrowserTitle ( browser webBrowser )
</syntaxhighlight>
{{OOP||[[Element/Browser|browser]]:getTitle|title}}

===Required arguments===
*'''webBrowser:''' The browser

===Returns===
Returns the title as a [[string]]. Returns false if invalid arguments were passed.

==Example==
<syntaxhighlight lang="lua">
addCommandHandler("browsers",
function()
outputChatBox("List of browser titles:")
for k, v in pairs( getElementsByType("web-browser") ) do
outputChatBox(k .. ". " .. getBrowserTitle(v))
end
end
)
</syntaxhighlight>

==See Also==
{{CEF_functions}}