ResetVehicleComponentScale: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(initial version)
(initial version)
 
(One intermediate revision by the same user not shown)
Line 2: Line 2:
{{Client function}}
{{Client function}}


{{New feature/item|3.0131|1.6.6|14489|
{{New feature/item|4.0140|1.5.6|14489|
This function sets the component scale of a [[vehicle]].
This function reset to default component scale for [[vehicle]].
}}
}}


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool setVehicleComponentScale ( vehicle theVehicle, string theComponent, float scaleX, float scaleY, float scaleZ [, string base = "root"] )
bool resetVehicleComponentScale ( vehicle theVehicle, string theComponent )
</syntaxhighlight>
</syntaxhighlight>
{{OOP||[[vehicle]]:setComponentScale||getVehicleComponentScale}}
{{OOP||[[vehicle]]:resetComponentScale}}


===Required Arguments===  
===Required Arguments===  
*'''theVehicle:''' The [[vehicle]] you wish to set component scale.
*'''theVehicle:''' The [[vehicle]] you wish to reset component scale.
*'''theComponent:''' A [[Vehicle_Components|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)
*'''scaleX:''' The new x scale of this component.
*'''scaleY:''' The new y scale of this component.
*'''scaleZ:''' The new z scale of this component.
 
===Optional Arguments===
{{New feature/item|3.0141|1.4.0|7013|
*'''base''': A string representing what the supplied scale (''scaleX'', ''scaleY'', ''scaleZ'') is relative to. It can be one of the following values:
**'''parent''': The scale is relative to the parent component.
**'''root''' (default if not specified): The scale is relative to the root component.
**'''world''': The scale is a world scale, relative to the world's center of coordinates.
}}


===Returns===  
===Returns===  
Returns ''true'' if component scale was set successfully, ''false'' otherwise.
Returns ''true'' if the scale of the component was reset, ''false'' otherwise.


==Example==  
==Example==  
'''Example 1:''' This example would set the scale of the component.  
'''Example 1:''' This example would change the scale of the component when the player enters a vehicle and resets it when he exit.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
addCommandHandler("scs", -- short for 'set component scale'
 
    function()
addEventHandler("onClientVehicleEnter", getRootElement(),
        local theVeh = getPedOccupiedVehicle(localPlayer)
function(player,seat)
local getComponent = getVehicleComponents(theVeh) -- returns table with all the components of the vehicle
    local getComponent = getVehicleComponents(source) -- returns table with all the components of the vehicle
        if (theVeh) then
    for k in pairs (getComponent) do
            for k in pairs (getComponent) do
      local x, y, z = getVehicleComponentScale(source, k) --get the scale of the component
local x, y, z = getVehicleComponentScale(theVeh, k) --get the scale of the component
      setVehicleComponentScale(source, k, x*2, y*2, z*2) -- double the sizes
                setVehicleComponentScale(theVeh, k, x*2, y*2, z*2) -- double the sizes
    end
            end
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
      resetVehicleComponentScale(source, k) -- resets the scale of the component
     end
     end
end
)
)
</syntaxhighlight>
</syntaxhighlight>

Latest revision as of 16:41, 27 June 2019

ADDED/UPDATED IN VERSION 1.5.6 r14489:

This function reset to default component scale for vehicle.

Syntax

bool resetVehicleComponentScale ( vehicle theVehicle, string theComponent )

OOP Syntax Help! I don't understand this!

Method: vehicle:resetComponentScale(...)


Required Arguments

  • theVehicle: The vehicle you wish to reset component scale.
  • 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 scale of the component was reset, false otherwise.

Example

Example 1: This example would change the scale 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 = getVehicleComponentScale(source, k) --get the scale of the component
       setVehicleComponentScale(source, k, x*2, y*2, z*2) -- double the sizes
    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
       resetVehicleComponentScale(source, k) -- resets the scale of the component
    end
 end
)

See Also



Retrieved from "https://wiki.multitheftauto.com/wiki/ResetVehicleComponentScale?oldid=63116"