GetVehicleTurretPosition - Revision history

Strix: OOP

2014-12-17T23:35:28Z

OOP

← Older revision		Revision as of 23:35, 17 December 2014
Line 5:		Line 5:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">float, float getVehicleTurretPosition ( vehicle turretVehicle )</syntaxhighlight>		<syntaxhighlight lang="lua">float, float getVehicleTurretPosition ( vehicle turretVehicle )</syntaxhighlight>
			{{OOP\|\|[[vehicle]]:getTurretPosition\|turretPosition\|setVehicleTurretPosition}}
	===Required Arguments===		===Required Arguments===
	*'''turretVehicle''': The [[vehicle]] whose turret position 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.

Snert: Corrected "Returns" field and the example. Removed the "Needs checking" messages

2010-11-08T10:16:50Z

Corrected "Returns" field and the example. Removed the "Needs checking" messages

← Older revision		Revision as of 10:16, 8 November 2010
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server client function}}		{{Server client function}}
	~~{{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.

Line 12:		Line 10:

	===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~~'' 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 ''0, 0'' if the vehicle is not a vehicle with a turret.

	==Example==		==Example==
Line 22:		Line 20:
	-- Get the vehicle's turret position		-- Get the vehicle's turret position
	local x, y = getVehicleTurretPosition ( vehicleValue )		local x, y = getVehicleTurretPosition ( vehicleValue )
	-- If the ~~vehicle has a turret (the function will return false~~ if it ~~doesn't~~) ~~then~~		-- Convert the positions to degrees, as that's much more useful if you'd want to output it
	if ( ~~x ~~~= ~~false~~ ) ~~then~~		x = math.deg ( x )
	-- Tell everyone in the ~~chat~~ the turret's position		y = math.deg ( y )
	~~outputChatBox~~ ( "~~Turret position~~: " .. x .. ", " .. y .. "." )		-- Get the vehicle's name
	~~end~~		local vehicleName = getVehicleName ( vehicleValue )
			-- Tell everyone in the F8 console the turret's position
			outputConsole ( vehicleName .. "'s turret rotation: " .. x .. ", " .. y .. "." )
	end		end
	</syntaxhighlight>		</syntaxhighlight>

Norby89 at 16:21, 26 August 2007

2007-08-26T16:21:04Z

← Older revision		Revision as of 16:21, 26 August 2007
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server client function}}		{{Server client function}}
	{{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.}}		{{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.

Jbeta: Removed reference to variants, removed Using Radians template

2007-08-23T13:04:49Z

Removed reference to variants, removed Using Radians template

← Older revision		Revision as of 13:04, 23 August 2007
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==

Norby89: /* Returns */

2007-08-18T17:29:37Z

Returns

← Older revision		Revision as of 17:29, 18 August 2007
Line 13:		Line 13:

	===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 does not have a driver or~~ 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'' in the first return value if the vehicle is not a vehicle with a turret.

	{{UsingRadians}}		{{UsingRadians}}

Norby89: /* Required Arguments */

2007-08-18T17:26:35Z

Required Arguments

← Older revision		Revision as of 17:26, 18 August 2007
Line 10:		Line 10:

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

	===Returns===		===Returns===

Norby89: /* Example */

2007-08-18T17:19:31Z

Example

← Older revision		Revision as of 17:19, 18 August 2007
Line 20:		Line 20:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	-- Find all the vehicles, and store them in a vehicles variable		-- Find all the vehicles, and store them in a vehicles variable
	vehicles = getElementsByType ( "vehicle" )		local vehicles = getElementsByType ( "vehicle" )
	-- Loop through the vehicle list		-- Loop through the vehicle list
	for vehicleKey, vehicleValue in ipairs(vehicles) do		for vehicleKey, vehicleValue in ipairs(vehicles) do
	-- Get the vehicle's turret position		-- Get the vehicle's turret position
	x, y = getVehicleTurretPosition ( vehicleValue )		local x, y = getVehicleTurretPosition ( vehicleValue )
	-- If the vehicle has a turret (the function will return false if it doesn't) then		-- If the vehicle has a turret (the function will return false if it doesn't) then
	if ( x ~= false ) then		if ( x ~= false ) then

Norby89 at 15:05, 18 August 2007

2007-08-18T15:05:32Z

← Older revision		Revision as of 15:05, 18 August 2007
Line 1:		Line 1:
	{{Server client function}}		{{Server client function}}
	__NOTOC__		__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)}}
	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.

Norby89 at 15:00, 18 August 2007

2007-08-18T15:00:24Z

← Older revision		Revision as of 15:00, 18 August 2007
Line 25:		Line 25:
	x, y = getVehicleTurretPosition ( vehicleValue )		x, y = getVehicleTurretPosition ( vehicleValue )
	-- If the vehicle has a turret (the function will return false if it doesn't) then		-- If the vehicle has a turret (the function will return false if it doesn't) then
	if ( x ~= false )		if ( x ~= false ) then
	-- Tell everyone in the chat the turret's position		-- Tell everyone in the chat the turret's position
	outputChatBox ( "Turret position: " .. x .. ", " .. y .. "." )		outputChatBox ( "Turret position: " .. x .. ", " .. y .. "." )

Arc at 17:06, 17 August 2007

2007-08-17T17:06:06Z

← Older revision		Revision as of 17:06, 17 August 2007
Line 1:		Line 1:
			{{Server client function}}
	__NOTOC__		__NOTOC__
	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.