SetVehicleComponentVisible: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(→‎Example: theVeh not needed because source is vehicle)
(improved theComponent description)
 
(8 intermediate revisions by 5 users not shown)
Line 2: Line 2:
{{Client function}}
{{Client function}}


{{New feature/item|4.0140|1.3.1|4715|
{{New feature/item|3.0131|1.3.1|4715|
This function sets component visibility for [[vehicle]].
This function sets component visibility for [[vehicle]].
}}
}}
Line 10: Line 10:
bool setVehicleComponentVisible ( vehicle theVehicle, string theComponent, bool visible )
bool setVehicleComponentVisible ( vehicle theVehicle, string theComponent, bool visible )
</syntaxhighlight>
</syntaxhighlight>
{{OOP||[[vehicle]]:setComponentVisible||getVehicleComponentVisible}}


===Required Arguments===  
===Required Arguments===  
*'''theVehicle:''' The [[vehicle]] you wish to set component visibility of.
*'''theVehicle:''' The [[vehicle]] you wish to set component visibility of.
*'''theComponent:''' A vehicle component (this is the frame name from the model file of the component you wish to modify)
*'''theComponent:''' A [[Vehicle_Components|vehicle component]] (this is the component's frame name (also called 'dummy') from the vehicle model's DFF file of which you want to manipulate components)
*'''visible:''' a ''bool'' which determines if the component should be visible
*'''visible:''' a ''bool'' which determines if the component should be visible


===Returns===  
===Returns===  
Returns a ''bool'' indicating the visible state of the component.
Returns a ''bool'' indicating if the visiblity was changed successfully.


==Example==  
==Example==  
'''Example 1:''' This example gets all the component and then hides them when you get into a vehicle.
'''Example 1:''' This example hide all components when you enter a vehicle.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
addEventHandler("onClientVehicleEnter", getRootElement(),
addEventHandler("onClientVehicleEnter", getRootElement(),
     function()
     function()
         local getComponent = getVehicleComponents(theVeh) -- returns table with all the components of the vehicle
         local getComponent = getVehicleComponents(source) -- get a table with all the components of the vehicle
         for k in pairs (getComponent) do
         for k in pairs (getComponent) do
             setVehicleComponentVisible(source, k, false) -- hides the component
             setVehicleComponentVisible(source, k, false) -- hides the component

Latest revision as of 00:57, 18 July 2019

This function sets component visibility for vehicle.

Syntax

bool setVehicleComponentVisible ( vehicle theVehicle, string theComponent, bool visible )

OOP Syntax Help! I don't understand this!

Method: vehicle:setComponentVisible(...)
Counterpart: getVehicleComponentVisible


Required Arguments

  • theVehicle: The vehicle you wish to set component visibility of.
  • theComponent: A vehicle component (this is the component's frame name (also called 'dummy') from the vehicle model's DFF file of which you want to manipulate components)
  • visible: a bool which determines if the component should be visible

Returns

Returns a bool indicating if the visiblity was changed successfully.

Example

Example 1: This example hide all components when you enter a vehicle. 

addEventHandler("onClientVehicleEnter", getRootElement(),
    function()
        local getComponent = getVehicleComponents(source) -- get a table with all the components of the vehicle
        for k in pairs (getComponent) do
            setVehicleComponentVisible(source, k, false) -- hides the component
        end
    end
)

See Also



Retrieved from "https://wiki.multitheftauto.com/wiki/SetVehicleComponentVisible?oldid=63311"