SetVehicleComponentPosition - Revision history

AlexTMjugador: Grammar fixes

2017-07-05T13:59:53Z

Grammar fixes

← Older revision		Revision as of 13:59, 5 July 2017
Line 3:		Line 3:

	{{New feature/item\|3.0131\|1.3.1\|4715\|		{{New feature/item\|3.0131\|1.3.1\|4715\|
	This function ~~set~~ component position ~~for~~ [[vehicle]].		This function sets the component position of a [[vehicle]].
	}}		}}

Line 15:		Line 15:
	*'''theVehicle:''' The [[vehicle]] you wish to set component position.		*'''theVehicle:''' The [[vehicle]] you wish to set component position.
	*'''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)
	*'''posX:''' The x position of this component ~~from the center of the vehicle~~.		*'''posX:''' The new x position of this component.
	*'''posY:''' The y position of this component ~~from the center of the vehicle~~.		*'''posY:''' The new y position of this component.
	*'''posZ:''' The z position of this component ~~from the center of the vehicle~~.		*'''posZ:''' The new z position of this component.

	===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 position is relative to. It can be one of the following values:		*'''base''': A string representing what the supplied position (''posX'', ''posY'', ''posZ'') is relative to. It can be one of the following values:
	**'''parent:''' The position is relative to the parent component.		**'''parent''': The position is relative to the parent component.
	**'''root:''' The position is relative to the root component.		**'''root''' (default if not specified): The position is relative to the root component.
	**'''world:''' The position is a world position.		**'''world''': The position is a world position, relative to the world's center of coordinates.
	}}		}}

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

	==Example==		==Example==

Lexr128 at 05:06, 15 April 2017

2017-04-15T05:06:44Z

← Older revision		Revision as of 05:06, 15 April 2017
Line 14:		Line 14:
	===Required Arguments===		===Required Arguments===
	*'''theVehicle:''' The [[vehicle]] you wish to set component position.		*'''theVehicle:''' The [[vehicle]] you wish to set component position.
	*'''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)
	*'''posX:''' The x position of this component from the center of the vehicle.		*'''posX:''' The x position of this component from the center of the vehicle.
	*'''posY:''' The y position of this component from the center of the vehicle.		*'''posY:''' The y position of this component from the center of the vehicle.

StrixG: Add OOP syntax

2017-02-23T10:07:14Z

Add OOP syntax

← Older revision		Revision as of 10:07, 23 February 2017
Line 10:		Line 10:
	bool setVehicleComponentPosition ( vehicle theVehicle, string theComponent, float posX, float posY, float posZ [, string base = "root"] )		bool setVehicleComponentPosition ( vehicle theVehicle, string theComponent, float posX, float posY, float posZ [, string base = "root"] )
	</syntaxhighlight>		</syntaxhighlight>
			{{OOP\|\|[[vehicle]]:setComponentPosition\|\|getVehicleComponentPosition}}

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

Ccw at 01:21, 13 January 2015

2015-01-13T01:21:02Z

← Older revision		Revision as of 01:21, 13 January 2015
Line 17:		Line 17:
	*'''posY:''' The y position of this component from the center of the vehicle.		*'''posY:''' The y position of this component from the center of the vehicle.
	*'''posZ:''' The z position of this component from the center of the vehicle.		*'''posZ:''' The z position of this component from the center of the vehicle.

			===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 position is relative to. It can be one of the following values:		*'''base:''' A string representing what the supplied position is relative to. It can be one of the following values:

Ccw at 01:17, 13 January 2015

2015-01-13T01:17:56Z

← Older revision		Revision as of 01:17, 13 January 2015
Line 8:		Line 8:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool setVehicleComponentPosition ( vehicle theVehicle, string theComponent, float posX, float posY, float posZ )		bool setVehicleComponentPosition ( vehicle theVehicle, string theComponent, float posX, float posY, float posZ [, string base = "root"] )
	</syntaxhighlight>		</syntaxhighlight>

Line 17:		Line 17:
	*'''posY:''' The y position of this component from the center of the vehicle.		*'''posY:''' The y position of this component from the center of the vehicle.
	*'''posZ:''' The z position of this component from the center of the vehicle.		*'''posZ:''' The z position of this component from the center of the vehicle.
			{{New feature/item\|3.0141\|1.4.0\|7013\|
			*'''base:''' A string representing what the supplied position is relative to. It can be one of the following values:
			**'''parent:''' The position is relative to the parent component.
			**'''root:''' The position is relative to the root component.
			**'''world:''' The position is a world position.
			}}

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

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

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

Miki785 at 11:47, 19 August 2014

2014-08-19T11:47:56Z

← Older revision		Revision as of 11:47, 19 August 2014
Line 2:		Line 2:
	{{Client function}}		{{Client function}}

	{{New feature/item\|4.~~0140~~\|1.3.1\|4715\|		{{New feature/item\|3.0131\|1.3.1\|4715\|
	This function set component position for [[vehicle]].		This function set component position for [[vehicle]].
	}}		}}

Prime at 17:40, 18 January 2014

2014-01-18T17:40:57Z

← Older revision		Revision as of 17:40, 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 23:		Line 22:

	==Example==		==Example==
	~~TODO~~		'''Example 1:''' This example would set the position of the component.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	-- ~~TODO~~		addCommandHandler("scp", -- short for 'set component position'
			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 x, y, z = getVehicleComponentPosition(theVeh, k) --get the position of the component
			setVehicleComponentPosition(theVeh, k, x+1, y+1, z+1) -- increases by 1 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:03Z

← 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 position for [[vehicle]].		This function set component position 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:23Z

← 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 position for [[vehicle]].		This function set component position for [[vehicle]].
	}}		}}

Cazomino05 at 20:34, 25 October 2012

2012-10-25T20:34:21Z

@@ Line 12: / Line 12: @@
 ===Required Arguments===
 *'''theVehicle:''' The [[vehicle]] you wish to set component position.
-*'''theComponent:''' A vehicle component:
+*'''theComponent:''' A vehicle component (this is the frame name from the model file of the component you wish to modify)
 *'''posX:''' The x position of this component from the center of the vehicle.
 *'''posY:''' The y position of this component from the center of the vehicle.