GetVehicleComponentRotation: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Client function}}
{{Client function}}
{{New feature/item|4.0140|1.3.1|4715|
This function get component rotation for [[vehicle]].
This function get component rotation for [[vehicle]].
}}


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
float, float, float getVehicleComponentRotation ( vehicle theVehicle, string theComponent )
float, float, float getVehicleComponentRotation ( vehicle theVehicle, string theComponent [, string base = "parent"] )
</syntaxhighlight>
</syntaxhighlight>


Line 14: Line 11:
*'''theVehicle:''' The [[vehicle]] you wish to get component rotation.
*'''theVehicle:''' The [[vehicle]] you wish to get 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 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 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===  
Returns three ''floats'' indicating the rotation of the component, ''x'', ''y'' and ''z'' respectively.
Returns three ''floats'' indicating the rotation of the component, ''x'', ''y'' and ''z'' respectively.


==Example==
==Example==  
==Example==  
'''Example 1:''' This example would get the name and the position of the components and output it in the chat.
'''Example 1:''' This example would get the name and the position of the components and output it in the chat.
Line 35: 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:24, 13 January 2015

This function get component rotation for vehicle.

Syntax

float, float, float getVehicleComponentRotation ( vehicle theVehicle, string theComponent [, string base = "parent"] )

Required Arguments

  • theVehicle: The vehicle you wish to get component rotation.
  • 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 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 three floats indicating the rotation of the component, x, y and z respectively.

Example

Example 1: This example would get the name and the position of the components and output it in the chat. 

addCommandHandler("vcr", -- short for 'vehicle component rotation'
    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)
                outputChatBox("Rotation of "..k.." is "..rx.." "..ry.." "..rz)
            end
        end
    end
)

Changelog

Version Description
1.4.0-9.07013 Added base argument

See Also



Retrieved from "https://wiki.multitheftauto.com/wiki/GetVehicleComponentRotation?oldid=43973"