SetVehicleComponentPosition: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
m (Grammar fixes)
 
(9 intermediate revisions by 7 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Client function}}
{{Client function}}
{{New items|3.0151|1.4|
 
This function set component position for [[vehicle]].
{{New feature/item|3.0131|1.3.1|4715|
This function sets the component position of a [[vehicle]].
}}
}}


==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>
{{OOP||[[vehicle]]:setComponentPosition||getVehicleComponentPosition}}


===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:
*'''theComponent:''' A [[Vehicle_Components|vehicle component]] (this is the frame name from the model file of the component you wish to modify)
**'''"special_1":'''  
*'''posX:''' The new x position of this component.
**'''"special_2":'''  
*'''posY:''' The new y position of this component.
**'''"special_3":'''  
*'''posZ:''' The new z position of this component.
**'''"special_4":'''
 
**'''"special_5":'''
===Optional Arguments===
**'''"bonnet":'''
{{New feature/item|3.0141|1.4.0|7013|
**'''"boot":'''  
*'''base''': A string representing what the supplied position (''posX'', ''posY'', ''posZ'') is relative to. It can be one of the following values:
**'''"bumper_1":'''  
**'''parent''': The position is relative to the parent component.
**'''"bumper_2":'''  
**'''root''' (default if not specified): The position is relative to the root component.
**'''"chassis":'''
**'''world''': The position is a world position, relative to the world's center of coordinates.
**'''"door_1":'''  
}}
**'''"door_2":'''
**'''"door_3":'''
**'''"door_4":'''
**'''"exhaust":'''
**'''"wing_lf":'''
**'''"wing_rf":'''
**'''"extra_1":'''
**'''"extra_2":'''
*'''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.


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


==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>
==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.4.0-9.07013|Added '''base''' argument}}


==See Also==
==See Also==
{{Client_vehicle_functions}}
{{Client_vehicle_functions}}
[[Category:Needs Example]]

Latest revision as of 13:59, 5 July 2017

This function sets the component position of a vehicle.

Syntax

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

OOP Syntax Help! I don't understand this!

Method: vehicle:setComponentPosition(...)
Counterpart: getVehicleComponentPosition


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 new x position of this component.
  • posY: The new y position of this component.
  • posZ: The new z position of this component.

Optional Arguments

  • 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.
    • root (default if not specified): The position is relative to the root component.
    • world: The position is a world position, relative to the world's center of coordinates.

Returns

Returns 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=51582"