SetVehicleComponentRotation - Revision history

FileEX at 11:57, 4 September 2024

2024-09-04T11:57:59Z

← Older revision		Revision as of 11:57, 4 September 2024
Line 19:		Line 19:
	{{New feature/item\|3.0141\|1.4.0\|7013\|		{{New feature/item\|3.0141\|1.4.0\|7013\|
	*'''base:''' A string representing what the supplied rotation (''rotX'', ''rotY'', ''rotZ'') is relative to. It can be one of the following values:		*'''base:''' A string representing what the supplied rotation (''rotX'', ''rotY'', ''rotZ'') is relative to. It can be one of the following values:
	**'''parent''' ~~(default if not specified):~~ The rotation is relative to the parent component.		**'''parent:''' The rotation is relative to the parent component.
	**'''root''': The rotation is relative to the root component.		**'''root:''' The rotation is relative to the root component.
	**'''world''': The rotation is a world rotation, relative to the world's coordinates axes.		**'''world:''' The rotation is a world rotation, relative to the world's coordinates axes.
	}}		}}

AlexTMjugador: Grammar fixes

2017-07-05T14:04:56Z

Grammar fixes

← Older revision		Revision as of 14:04, 5 July 2017
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Client function}}		{{Client function}}
	This function ~~set~~ component rotation ~~for~~ [[vehicle]].		This function sets the component rotation of a [[vehicle]].
	{{Note\|Before r6974 the component rotations went the wrong way (i.e. opposite to the vehicle rotations). This has been corrected, so you'll have to modify any scripts written before r6974 that use this function.}}		{{Note\|Before r6974 the component rotations went the wrong way (i.e. opposite to the vehicle rotations). This has been corrected, so you'll have to modify any scripts written before r6974 that use this function.}}
	==Syntax==		==Syntax==
Line 10:		Line 10:

	===Required Arguments===		===Required Arguments===
	*'''theVehicle:''' The [[vehicle]] you wish to set component rotation.		*'''theVehicle:''' The [[vehicle]] you wish to set component rotation of.
	*'''theComponent:''' A [[Vehicle_Components\|vehicle component]] (this is the frame name from the model file of the component you wish to modify)		*'''theComponent:''' A [[Vehicle_Components\|vehicle component]] (this is the frame name from the model file of the component you wish to modify)
	*'''rotX:''' The component's rotation around the x axis in degrees.		*'''rotX:''' The component's rotation around the x axis in degrees.
Line 18:		Line 18:
	===Optional Arguments===		===Optional Arguments===
	{{New feature/item\|3.0141\|1.4.0\|7013\|		{{New feature/item\|3.0141\|1.4.0\|7013\|
	*'''base:''' A string representing what the supplied rotation is relative to. It can be one of the following values:		*'''base:''' A string representing what the supplied rotation (''rotX'', ''rotY'', ''rotZ'') is relative to. It can be one of the following values:
	**'''parent:''' The rotation is relative to the parent component.		**'''parent''' (default if not specified): The rotation is relative to the parent component.
	**'''root:''' The rotation is relative to the root component.		**'''root''': The rotation is relative to the root component.
	**'''world:''' The rotation is a world rotation.		**'''world''': The rotation is a world rotation, relative to the world's coordinates axes.
	}}		}}

	===Returns===		===Returns===
	~~Return~~ ''true'' if component rotation was set successfully, ''false'' otherwise.		Returns ''true'' if the component rotation was set successfully, ''false'' otherwise.

	==Example==		==Example==

Lexr128 at 05:06, 15 April 2017

2017-04-15T05:06:31Z

← Older revision		Revision as of 05:06, 15 April 2017
Line 11:		Line 11:
	===Required Arguments===		===Required Arguments===
	*'''theVehicle:''' The [[vehicle]] you wish to set component rotation.		*'''theVehicle:''' The [[vehicle]] you wish to set component rotation.
	*'''theComponent:''' A vehicle component (this is the frame name from the model file of the component you wish to modify)		*'''theComponent:''' A [[Vehicle_Components\|vehicle component]] (this is the frame name from the model file of the component you wish to modify)
	*'''rotX:''' The component's rotation around the x axis in degrees.		*'''rotX:''' The component's rotation around the x axis in degrees.
	*'''rotY:''' The component's rotation around the y axis in degrees.		*'''rotY:''' The component's rotation around the y axis in degrees.

StrixG: Add OOP syntax

2017-02-23T10:08:20Z

Add OOP syntax

← Older revision		Revision as of 10:08, 23 February 2017
Line 7:		Line 7:
	bool setVehicleComponentRotation ( vehicle theVehicle, string theComponent, float rotX, float rotY, float rotZ [, string base = "parent"] )		bool setVehicleComponentRotation ( vehicle theVehicle, string theComponent, float rotX, float rotY, float rotZ [, string base = "parent"] )
	</syntaxhighlight>		</syntaxhighlight>
			{{OOP\|\|[[vehicle]]:setComponentRotation\|\|getVehicleComponentRotation}}

	===Required Arguments===		===Required Arguments===

Ccw at 02:51, 18 January 2015

2015-01-18T02:51:55Z

← Older revision		Revision as of 02:51, 18 January 2015
Line 2:		Line 2:
	{{Client function}}		{{Client function}}
	This function set component rotation for [[vehicle]].		This function set component rotation for [[vehicle]].
			{{Note\|Before r6974 the component rotations went the wrong way (i.e. opposite to the vehicle rotations). This has been corrected, so you'll have to modify any scripts written before r6974 that use this function.}}
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

Ccw at 01:22, 13 January 2015

2015-01-13T01:22:54Z

← Older revision		Revision as of 01:22, 13 January 2015
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Client function}}		{{Client function}}

	~~{{New feature/item\|4.0140\|1.3.1\|4715\|~~
	This function set component rotation for [[vehicle]].		This function set component rotation for [[vehicle]].
	}}

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool setVehicleComponentRotation ( vehicle theVehicle, string theComponent, float rotX, float rotY, float rotZ )		bool setVehicleComponentRotation ( vehicle theVehicle, string theComponent, float rotX, float rotY, float rotZ [, string base = "parent"] )
	</syntaxhighlight>		</syntaxhighlight>

Line 17:		Line 14:
	*'''rotY:''' The component's rotation around the y axis in degrees.		*'''rotY:''' The component's rotation around the y axis in degrees.
	*'''rotZ:''' The component's rotation around the z axis in degrees.		*'''rotZ:''' The component's rotation around the z axis in degrees.

			===Optional Arguments===
			{{New feature/item\|3.0141\|1.4.0\|7013\|
			*'''base:''' A string representing what the supplied rotation is relative to. It can be one of the following values:
			**'''parent:''' The rotation is relative to the parent component.
			**'''root:''' The rotation is relative to the root component.
			**'''world:''' The rotation is a world rotation.
			}}

	===Returns===		===Returns===
Line 37:		Line 42:
	)		)
	</syntaxhighlight>		</syntaxhighlight>

			==Changelog==
			{{ChangelogHeader}}
			{{ChangelogItem\|1.4.0-9.07013\|Added '''base''' argument}}

	==See Also==		==See Also==
	{{Client_vehicle_functions}}		{{Client_vehicle_functions}}

Prime at 18:07, 18 January 2014

2014-01-18T18:07:36Z

← Older revision		Revision as of 18:07, 18 January 2014
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Client function}}		{{Client function}}
	~~{{Needs_Example}}~~

	{{New feature/item\|4.0140\|1.3.1\|4715\|		{{New feature/item\|4.0140\|1.3.1\|4715\|
Line 22:		Line 21:
	Return ''true'' if component rotation was set successfully, ''false'' otherwise.		Return ''true'' if component rotation was set successfully, ''false'' otherwise.

	==Example==		==Example==
	~~TODO~~		'''Example 1:''' This example would change the roatation of the component when the player enters a vehicle.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	--~~TODO~~		addEventHandler("onClientVehicleEnter", getRootElement(),
			function()
			local theVeh = getPedOccupiedVehicle(localPlayer)
			local getComponent = getVehicleComponents(theVeh) -- returns table with all the components of the vehicle
			if (theVeh) then
			for k in pairs (getComponent) do
			local rx, ry, rz = getVehicleComponentRotation(theVeh, k) --get the rotation of the component
			setVehicleComponentRotation(theVeh, k, rx+10, ry+10, rz+10) -- increases by 10 unit
			end
			end
			end
			)
	</syntaxhighlight>		</syntaxhighlight>

	==See Also==		==See Also==
	{{Client_vehicle_functions}}		{{Client_vehicle_functions}}

Myonlake at 12:55, 2 January 2014

2014-01-02T12:55:09Z

← Older revision		Revision as of 12:55, 2 January 2014
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Client function}}		{{Client function}}
			{{Needs_Example}}

	{{New feature/item\|4.0140\|1.3.1\|4715\|		{{New feature/item\|4.0140\|1.3.1\|4715\|
	This function set component rotation for [[vehicle]].		This function set component rotation for [[vehicle]].
Line 28:		Line 30:
	==See Also==		==See Also==
	{{Client_vehicle_functions}}		{{Client_vehicle_functions}}
	~~[[Category:Needs Example]]~~

Cazomino05 at 20:37, 25 October 2012

2012-10-25T20:37:33Z

← Older revision		Revision as of 20:37, 25 October 2012
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Client function}}		{{Client function}}
	{{New ~~items~~\|3.~~0151~~\|1.4\|		{{New feature/item\|4.0140\|1.3.1\|4715\|
	This function set component rotation for [[vehicle]].		This function set component rotation for [[vehicle]].
	}}		}}

Cazomino05 at 20:35, 25 October 2012

2012-10-25T20:35:40Z

@@ Line 12: / Line 12: @@
 ===Required Arguments===
 *'''theVehicle:''' The [[vehicle]] you wish to set component rotation.
-*'''theComponent:''' A vehicle component:
+*'''theComponent:''' A vehicle component (this is the frame name from the model file of the component you wish to modify)
 *'''rotX:''' The component's rotation around the x axis in degrees.
 *'''rotY:''' The component's rotation around the y axis in degrees.