SetVehicleComponentVisible: 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 20: Line 19:
Returns a ''bool'' indicating the visible state of the component.
Returns a ''bool'' indicating the visible state of the component.


==Example==
==Example==  
TODO
'''Example 1:''' This example gets all the component and then hides them when you get into a vehicle. 
<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
                setVehicleComponentVisible(theVeh, k, false) -- hides the component
            end
        end
    end
)
</syntaxhighlight>
</syntaxhighlight>


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

Revision as of 18:12, 18 January 2014

ADDED/UPDATED IN VERSION 1.3.1 r4715:

This function sets component visibility for vehicle.

Syntax

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

Required Arguments

  • 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)
  • visible: a bool which determines if the component should be visible

Returns

Returns a bool indicating the visible state of the component.

Example

Example 1: This example gets all the component and then hides them when you get into a vehicle. 

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
                setVehicleComponentVisible(theVeh, k, false) -- hides the component
            end
        end
    end
)

See Also



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