ResetVehicleComponentPosition: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Client function}}
{{Client function}}
{{Needs_Example}}


{{New feature/item|4.0140|1.3.1|4715|
{{New feature/item|4.0140|1.3.1|4715|
Line 19: Line 18:
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 you type /reset. 
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--TODO
 
addEventHandler("onClientVehicleEnter", getRootElement(),
    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
)
 
addCommandHandler("reset",
    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
                resetVehicleComponentPosition(theVeh, k) -- resets the position of the component
    end
        end
    end
)
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{Client_vehicle_functions}}
{{Client_vehicle_functions}}

Revision as of 18:01, 18 January 2014

ADDED/UPDATED IN VERSION 1.3.1 r4715:

This function reset to default component position for vehicle.

Syntax

bool resetVehicleComponentPosition ( vehicle theVehicle, string theComponent )

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 you type /reset.


addEventHandler("onClientVehicleEnter", getRootElement(),
    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
)

addCommandHandler("reset",
    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
                resetVehicleComponentPosition(theVeh, k) -- resets the position of the component
	    end
        end
    end
)

See Also