GetVehicleTurretPosition: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Removed reference to variants, removed Using Radians template)
Line 1: Line 1:
__NOTOC__
{{Server client function}}
{{Server client function}}
__NOTOC__
{{Needs Checking|if the vehicle has no turret it returns 0, 0 not ''false''as the desciption says --[[User:Norby89|Norby89]] 10:05, 18 August 2007 (CDT)}}
{{Needs Checking|if the vehicle has no turret it returns 0, 0 not ''false''as the desciption says --[[User:Norby89|Norby89]] 10:05, 18 August 2007 (CDT)}}
{{Needs Checking|"Returns" section info is wrong, this function doesn't retrieve rotation. The example could be improved.}}
This function gets the position of a vehicle's turret, if it has one. Vehicles with turrets include firetrucks and tanks.
This function gets the position of a vehicle's turret, if it has one. Vehicles with turrets include firetrucks and tanks.


==Syntax==
==Syntax==
<syntaxhighlight lang="lua">float float getVehicleTurretPosition ( vehicle turretVehicle )</syntaxhighlight>
<syntaxhighlight lang="lua">float, float getVehicleTurretPosition ( vehicle turretVehicle )</syntaxhighlight>
 
This function also has two variants that allow you to retrieve data from just one of the two axes.


===Required Arguments===
===Required Arguments===
*'''turretVehicle''': The [[vehicle]] whose rotation you want to retrieve. This should be a vehicle with a turret.
*'''turretVehicle''': The [[vehicle]] whose turret position you want to retrieve. This should be a vehicle with a turret.


===Returns===
===Returns===
Returns two [[float]]s for the X (horizontal) and Y (vertical) axis rotation respectively. These values are in radians. The function will return ''false'' in the first return value if the vehicle is not a vehicle with a turret.  
Returns two [[float]]s for the X (horizontal) and Y (vertical) axis rotation respectively. These values are in radians. The function will return ''false'' if the vehicle is not a vehicle with a turret.  
 
{{UsingRadians}}


==Example==
==Example==

Revision as of 13:04, 23 August 2007

Dialog-information.png This article needs checking.
Reason(s): if the vehicle has no turret it returns 0, 0 not falseas the desciption says --Norby89 10:05, 18 August 2007 (CDT)
Dialog-information.png This article needs checking.
Reason(s): "Returns" section info is wrong, this function doesn't retrieve rotation. The example could be improved.

This function gets the position of a vehicle's turret, if it has one. Vehicles with turrets include firetrucks and tanks.

Syntax

float, float getVehicleTurretPosition ( vehicle turretVehicle )

Required Arguments

  • turretVehicle: The vehicle whose turret position you want to retrieve. This should be a vehicle with a turret.

Returns

Returns two floats for the X (horizontal) and Y (vertical) axis rotation respectively. These values are in radians. The function will return false if the vehicle is not a vehicle with a turret.

Example

-- Find all the vehicles, and store them in a vehicles variable
local vehicles = getElementsByType ( "vehicle" )
-- Loop through the vehicle list
for vehicleKey, vehicleValue in ipairs(vehicles) do
	-- Get the vehicle's turret position
	local x, y = getVehicleTurretPosition ( vehicleValue ) 
	-- If the vehicle has a turret (the function will return false if it doesn't) then
	if ( x ~= false ) then
		-- Tell everyone in the chat the turret's position
		outputChatBox ( "Turret position: " .. x .. ", " .. y .. "." )	
	end
end

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/GetVehicleTurretPosition?oldid=11290"