ResetVehicleComponentPosition: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(Add OOP syntax)
 
(5 intermediate revisions by 4 users not shown)
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 reset to default component position for [[vehicle]].
This function reset to default component position for [[vehicle]].
}}
}}
Line 9: Line 10:
bool resetVehicleComponentPosition ( vehicle theVehicle, string theComponent )
bool resetVehicleComponentPosition ( vehicle theVehicle, string theComponent )
</syntaxhighlight>
</syntaxhighlight>
{{OOP||[[vehicle]]:resetComponentPosition}}


===Required Arguments===  
===Required Arguments===  
*'''theVehicle:''' The [[vehicle]] you wish to reset component position.
*'''theVehicle:''' The [[vehicle]] you wish to reset 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)
**'''"special_1":'''
**'''"special_2":'''
**'''"special_3":'''
**'''"special_4":'''
**'''"special_5":'''
**'''"bonnet":'''
**'''"boot":'''
**'''"bumper_1":'''
**'''"bumper_2":'''
**'''"chassis":'''
**'''"door_1":'''
**'''"door_2":'''
**'''"door_3":'''
**'''"door_4":'''
**'''"exhaust":'''
**'''"wing_lf":'''
**'''"wing_rf":'''
**'''"extra_1":'''
**'''"extra_2":'''


===Returns===  
===Returns===  
Returns ''true'' if the position of the component was reset, ''false'' otherwise.
Returns ''true'' if the position of the component was reset, ''false'' otherwise.


==Example==
==Example==  
TODO
'''Example 1:''' This example would change the position of the component when the player enters a vehicle and resets it when he exit. 
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--TODO
 
addEventHandler("onClientVehicleEnter", getRootElement(),
function(player,seat)
    local getComponent = getVehicleComponents(source) -- returns table with all the components of the vehicle
    for k in pairs (getComponent) do
      local x, y, z = getVehicleComponentPosition(source, k) --get the position of the component
      setVehicleComponentPosition(source, k, x+1, y+1, z+1) -- increases by 1 unit
    end
end
)
addEventHandler("onClientVehicleExit", getRootElement(),
function(player, seat)
    local getComponent = getVehicleComponents(source) -- returns table with all the components of the vehicle
    for k in pairs (getComponent) do
      resetVehicleComponentPosition(source, k) -- resets the position of the component
    end
end
)
</syntaxhighlight>
</syntaxhighlight>


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

Latest revision as of 10:15, 23 February 2017

ADDED/UPDATED IN VERSION 1.3.1 r4715:

This function reset to default component position for vehicle.

Syntax

bool resetVehicleComponentPosition ( vehicle theVehicle, string theComponent )

OOP Syntax Help! I don't understand this!

Method: vehicle:resetComponentPosition(...)


Required Arguments

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

Returns

Returns true if the position of the component was reset, false otherwise.

Example

Example 1: This example would change the position of the component when the player enters a vehicle and resets it when he exit. 


addEventHandler("onClientVehicleEnter", getRootElement(),
 function(player,seat)
    local getComponent = getVehicleComponents(source) -- returns table with all the components of the vehicle
    for k in pairs (getComponent) do
       local x, y, z = getVehicleComponentPosition(source, k) --get the position of the component
       setVehicleComponentPosition(source, k, x+1, y+1, z+1) -- increases by 1 unit
    end
 end
)
 
addEventHandler("onClientVehicleExit", getRootElement(),
 function(player, seat)
    local getComponent = getVehicleComponents(source) -- returns table with all the components of the vehicle
    for k in pairs (getComponent) do
       resetVehicleComponentPosition(source, k) -- resets the position of the component
    end
 end
)

See Also



Retrieved from "https://wiki.multitheftauto.com/wiki/ResetVehicleComponentPosition?oldid=50507"