SetVehicleComponentPosition: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
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}}

Revision as of 01:17, 13 January 2015

This function set component position for vehicle.

Syntax

bool setVehicleComponentPosition ( vehicle theVehicle, string theComponent, float posX, float posY, float posZ [, string base = "root"] )

Required Arguments

  • 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)
  • 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.
  • posZ: The z position of this component from the center of the vehicle.
  • 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

Return true if component position was set successfully, false otherwise.

Example

Example 1: This example would set the position of the component. 

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
)

Changelog

Version Description
1.4.0-9.07013 Added base argument

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/SetVehicleComponentPosition?oldid=43969"