GetVehicleHoodRatio: Difference between revisions

From Onset Developer Wiki
Created page with "{{Info|Function|Server|1.0}} {{FuncDescription|__EDIT_ME__}} {{FuncSyntax|GetVehicleHoodRatio(vehicle)}} {{FuncParameters}} {{FuncParam|vehicle|__EDIT_ME__}} {{FuncReturnV..."
 
28days (talk | contribs)
833 edits
No edit summary
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Info|Function|Server|1.0}}
{{Info|Function|Server & Client|1.0}}


{{FuncDescription|__EDIT_ME__}}
{{FuncDescription|Get the vehicle's hood ratio.}}


{{FuncSyntax|GetVehicleHoodRatio(vehicle)}}
{{FuncSyntax|GetVehicleHoodRatio(vehicle)}}


{{FuncParameters}}
{{FuncParameters}}
{{FuncParam|vehicle|__EDIT_ME__}}
{{FuncParam|vehicle|The vehicle identifier.}}


{{FuncReturnValue|__EDIT_ME__}}
{{FuncReturnValue|Returns the ratio of the vehicle hood.}}


== Example ==
== Example ==
__EDIT_ME__
<syntaxhighlight lang="Lua>
function cmd_hood(player, ratio)
local vehicle = GetPlayerVehicle(player)
 
if (vehicle == 0) then
return AddPlayerChat(player, "You must be in a vehicle")
end
 
if (GetPlayerVehicleSeat(player) ~= 1) then
return AddPlayerChat(player, "You must be the driver of the vehicle")
end
 
if (ratio == nil) then
if (GetVehicleHoodRatio(vehicle) > 0.0) then
SetVehicleHoodRatio(vehicle, 0.0)
else
SetVehicleHoodRatio(vehicle, 60.0)
end
else
ratio = tonumber(ratio)
 
if (ratio > 90.0) then
ratio = 90.0
elseif (ratio < 0.0) then
ratio = 0.0
end
 
SetVehicleHoodRatio(vehicle, ratio)
end
end
AddCommand("hood", cmd_hood)
</syntaxhighlight>


{{RelatedFunctions}}
{{RelatedFunctions}}
__EDIT_ME__
{{Template:VehicleFunctions}}

Latest revision as of 10:23, 19 November 2019

GetVehicleHoodRatio

Type: Function
Context: Server & Client
Introduced: v1.0

Description

Get the vehicle's hood ratio.

Syntax

GetVehicleHoodRatio(vehicle)

Parameters

  • vehicle
    The vehicle identifier.

Return Value

  • Returns the ratio of the vehicle hood.

Example

function cmd_hood(player, ratio)
	local vehicle = GetPlayerVehicle(player)

	if (vehicle == 0) then
		return AddPlayerChat(player, "You must be in a vehicle")
	end

	if (GetPlayerVehicleSeat(player) ~= 1) then
		return AddPlayerChat(player, "You must be the driver of the vehicle")
	end

	if (ratio == nil) then
		if (GetVehicleHoodRatio(vehicle) > 0.0) then
			SetVehicleHoodRatio(vehicle, 0.0)
		else
			SetVehicleHoodRatio(vehicle, 60.0)
		end
	else
		ratio = tonumber(ratio)

		if (ratio > 90.0) then
			ratio = 90.0
		elseif (ratio < 0.0) then
			ratio = 0.0
		end

		SetVehicleHoodRatio(vehicle, ratio)
	end
end
AddCommand("hood", cmd_hood)

See also

Retrieved from "https://dev.playonset.com/index.php?title=GetVehicleHoodRatio&oldid=2867"