Difference between revisions of "GetVehicleComponentPosition"

From Multi Theft Auto: Wiki
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 
{{Client function}}
 
{{Client function}}
 
{{New feature/item|4.0140|1.3.1|4715|
 
 
This function get component position for [[vehicle]].
 
This function get component position for [[vehicle]].
}}
 
  
 
==Syntax==  
 
==Syntax==  
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
float, float, float getVehicleComponentPosition ( vehicle theVehicle, string theComponent )
+
float, float, float getVehicleComponentPosition ( vehicle theVehicle, string theComponent [, string base = "root"] )
 
</syntaxhighlight>
 
</syntaxhighlight>
  
Line 14: Line 11:
 
*'''theVehicle:''' The [[vehicle]] you wish to get component position.
 
*'''theVehicle:''' The [[vehicle]] you wish to get 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 component (this is the frame name from the model file of the component you wish to modify)
 +
 +
===Optional Arguments===
 +
{{New feature/item|3.0141|1.4.0|7013|
 +
*'''base:''' A string representing what the returned 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 34: Line 39:
 
)
 
)
 
</syntaxhighlight>
 
</syntaxhighlight>
 +
 +
==Changelog==
 +
{{ChangelogHeader}}
 +
{{ChangelogItem|1.4.0-9.07013|Added '''base''' argument}}
  
 
==See Also==
 
==See Also==
 
{{Client_vehicle_functions}}
 
{{Client_vehicle_functions}}

Revision as of 01:20, 13 January 2015

This function get component position for vehicle.

Syntax

float, float, float getVehicleComponentPosition ( vehicle theVehicle, string theComponent [, string base = "root"] )

Required Arguments

  • theVehicle: The vehicle you wish to get component position.
  • theComponent: A vehicle component (this is the frame name from the model file of the component you wish to modify)

Optional Arguments

  • base: A string representing what the returned 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 three floats indicating the position of the component, x, y and z respectively.

Example

This example gets the name and the position of the components and outputs it in the chat.

addCommandHandler("vcp", -- short for 'vehicle 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)
                outputChatBox("Position of "..k.." is"..x.." "..y.." "..z)
            end
        end
    end
)

Changelog

Version Description
1.4.0-9.07013 Added base argument

See Also

BETA: FROM VERSION 1.5.7 r19626 ONWARDS
BETA: FROM VERSION 1.6 r7485 ONWARDS
BETA: FROM VERSION 1.6 r7485 ONWARDS