GetVehicleTurretPosition: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(OOP)
 
(18 intermediate revisions by 7 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
==Description==
{{Server client function}}
This function returns two floats containing the rotational position of the vehicle's turret along the horizontal and vertical axes (X and Y) respectively. This function can fail if the player is not in a vehicle, or if the vehicle does not have a turret. Vehicles with turrets include tanks and fire trucks. If this function does fail, the first argument will be set to 'false'.
This function gets the position of a vehicle's turret, if it has one. Vehicles with turrets include firetrucks and tanks.


==Syntax==
==Syntax==
float float [[GetVehicleTurretPosition]] ( [[vehicle]] vehicle )
<syntaxhighlight lang="lua">float, float getVehicleTurretPosition ( vehicle turretVehicle )</syntaxhighlight>
 
{{OOP||[[vehicle]]:getTurretPosition|turretPosition|setVehicleTurretPosition}}
This function also has two variants that allow you to retrieve data from just one of the two axes.
===Required Arguments===
 
*'''turretVehicle''': The [[vehicle]] whose turret position you want to retrieve. This should be a vehicle with a turret.
float [[GetVehicleTurretPosition|GetVehicleTurretPositionX]] ( [[vehicle]] vehicle )


float [[GetVehicleTurretPosition|GetVehicleTurretPositionY]] ( [[vehicle]] vehicle )
===Returns===
{{UsingRadians}}
Returns two [[float]]s for the X (horizontal) and Y (vertical) axis rotation respectively. These values are in radians. The function will return ''0, 0'' if the vehicle is not a vehicle with a turret.  
===Required Arguments===
*'''vehicle''': The [[vehicle]] whose rotation you want to retrieve.


==Example==
==Example==
<syntaxhighlight lang="lua">
-- 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 )
-- Convert the positions to degrees, as that's much more useful if you'd want to output it
x = math.deg ( x )
y = math.deg ( y )
-- Get the vehicle's name
local vehicleName = getVehicleName ( vehicleValue )
-- Tell everyone in the F8 console the turret's position
outputConsole ( vehicleName .. "'s turret rotation: " .. x .. ", " .. y .. "." )
end
</syntaxhighlight>


newcar = [[createVehicle]] ( 520, 1024, 1024, 1024 )
==See Also==
x, y = [[GetVehicleTurretPosition]] ( newcar )
{{Vehicle functions}}
if (x)
  [[serverChat]] ( "Turret position: ",x,",",y,"." )
end

Latest revision as of 23:35, 17 December 2014

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 )

OOP Syntax Help! I don't understand this!

Method: vehicle:getTurretPosition(...)
Variable: .turretPosition
Counterpart: setVehicleTurretPosition


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 0, 0 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 ) 
	-- Convert the positions to degrees, as that's much more useful if you'd want to output it
	x = math.deg ( x )
	y = math.deg ( y )
	-- Get the vehicle's name
	local vehicleName = getVehicleName ( vehicleValue )
	-- Tell everyone in the F8 console the turret's position
	outputConsole ( vehicleName .. "'s turret rotation: " .. x .. ", " .. y .. "." )	
end

See Also


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