GetVehicleNitroLevel: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "__NOTOC__ {{Client function}} {{New feature/item|4.0140|1.3.1|4993| This function get the nitro level from the vehicle. }} ==Syntax== <syntaxhighlight lang="lua">float getVehicleNitroLev...")
 
(Missing dot.)
 
(14 intermediate revisions by 4 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Client function}}
{{Client function}}
{{New feature/item|4.0140|1.3.1|4993|
{{New feature/item|3.0131|1.3.1|4993|
This function get the nitro level from the [[vehicle]].
This function gets the nitro level of the [[vehicle]].
}}
}}
 
{{Warning|Only works if the vehicle is streamed in.}}
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">float getVehicleNitroLevel ( vehicle theVehicle )</syntaxhighlight>  
<syntaxhighlight lang="lua">float getVehicleNitroLevel ( vehicle theVehicle )</syntaxhighlight>  


===Required Arguments===  
===Required Arguments===  
*'''theVehicle''' The [[vehicle]] which you want to get a nitro level.
*'''theVehicle''' The [[vehicle]], which you want to get a nitro level.


===Returns===
===Returns===
Returns the nitro level from the vehicle.
Returns ''a float'' determining the nitro level (ranges from 0.0001 to 1.0) of the vehicle, ''false'' if there is no nitro in the vehicle.


==Example==
==Example==
<syntaxhighlight lang="lua">addEventHandler( 'onClientVehicleEnter', root,
<section name="Client" class="client" show="true">
function( pPlayer )
This function displays the nitro level of the vehicle the player is entering.
if pPlayer == localPlayer then
<syntaxhighlight lang="lua">
local fNitroLevel = getVehicleNitroLevel( source )
function displayNitroLevel(pPlayer)
setVehicleNitroLevel( source, fNitroLevel + 0.5 )
if pPlayer == localPlayer then
if getVehicleUpgradeOnSlot(source, 8) then -- Check if the vehicle has nitro installed
local fNitroLevel = getVehicleNitroLevel(source)
outputChatBox("The nitro level of this " .. getVehicleName(source) .. " is " .. fNitroLevel .. ".", 255, 180, 20, false)
end
end
end
end
)</syntaxhighlight>
end
addEventHandler("onClientVehicleEnter", root, displayNitroLevel)
</syntaxhighlight>
</section>


==Requirements==
==Requirements==
Line 28: Line 34:


==See Also==
==See Also==
{{Vehicle functions}}
{{Client_vehicle_functions}}

Latest revision as of 19:07, 15 June 2021

This function gets the nitro level of the vehicle.

[[|link=|]] Warning: Only works if the vehicle is streamed in.

Syntax

float getVehicleNitroLevel ( vehicle theVehicle )

Required Arguments

  • theVehicle The vehicle, which you want to get a nitro level.

Returns

Returns a float determining the nitro level (ranges from 0.0001 to 1.0) of the vehicle, false if there is no nitro in the vehicle.

Example

Click to collapse [-]
Client

This function displays the nitro level of the vehicle the player is entering.

function displayNitroLevel(pPlayer)
	if pPlayer == localPlayer then
		if getVehicleUpgradeOnSlot(source, 8) then -- Check if the vehicle has nitro installed
			local fNitroLevel = getVehicleNitroLevel(source)
			outputChatBox("The nitro level of this " .. getVehicleName(source) .. " is " .. fNitroLevel .. ".", 255, 180, 20, false)
		end
	end
end
addEventHandler("onClientVehicleEnter", root, displayNitroLevel)

Requirements

Minimum server version n/a
Minimum client version 1.3.1-9.04993

Note: Using this feature requires the resource to have the above minimum version declared in the meta.xml <min_mta_version> section. e.g. <min_mta_version client="1.3.1-9.04993" />

See Also