GetVehicleComponentVisible: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "__NOTOC__ {{Client function}} {{New feature/item|4.0140|1.3.1|4715| This function get component visibility for vehicle. }} ==Syntax== <syntaxhighlight lang="lua"> bool getVehicleComponent...")
 
mNo edit summary
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Client function}}
{{Client function}}
{{New feature/item|4.0140|1.3.1|4715|
{{New feature/item|4.0140|1.3.1|4715|
This function get component visibility for [[vehicle]].
This function get component visibility for [[vehicle]].
Line 9: Line 10:
bool getVehicleComponentVisible ( vehicle theVehicle, string theComponent )
bool getVehicleComponentVisible ( vehicle theVehicle, string theComponent )
</syntaxhighlight>
</syntaxhighlight>
{{OOP||[[vehicle]]:getComponentVisible||setVehicleComponentVisible}}


===Required Arguments===  
===Required Arguments===  
*'''theVehicle:''' The [[vehicle]] you wish to get component visibility of.
*'''theVehicle:''' The [[vehicle]] you wish to get 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 frame name from the model file of the component you wish to modify)


===Returns===  
===Returns===  
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 would get the name and tells if the component is visible or not.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--TODO
addCommandHandler("icv", -- short for 'is component visible'
    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 isVisible = getVehicleComponentVisible(theVeh, k) -- gets if it is visible or not
if (isVisible == true) then
    outputChatBox(k.." is visible")
else
    outputChatBox(k.." is not visible")
end 
            end
        end
    end
)
 
</syntaxhighlight>
</syntaxhighlight>


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

Latest revision as of 05:07, 15 April 2017

ADDED/UPDATED IN VERSION 1.3.1 r4715:

This function get component visibility for vehicle.

Syntax

bool getVehicleComponentVisible ( vehicle theVehicle, string theComponent )

OOP Syntax Help! I don't understand this!

Method: vehicle:getComponentVisible(...)
Counterpart: setVehicleComponentVisible


Required Arguments

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

Returns

Returns a bool indicating the visible state of the component.

Example

Example 1: This example would get the name and tells if the component is visible or not. 

addCommandHandler("icv", -- short for 'is component visible'
    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 isVisible = getVehicleComponentVisible(theVeh, k) -- gets if it is visible or not
		if (isVisible == true) then
		    outputChatBox(k.." is visible")
		else
		    outputChatBox(k.." is not visible")
		end   
            end
        end
    end
)

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/GetVehicleComponentVisible?oldid=50671"