GetVehiclePanelState: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
m (Fixed broken redirect.)
 
(11 intermediate revisions by 5 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Needs Checking|A list of panels would be nice and a more specific explanation on what the function returns --[[User:Norby89|Norby89]] 12:30, 26 August 2007 (CDT)}}
{{Server client function}}
{{Server client function}}
This function returns the current state of a specifed panel on the vehicle. A vehicle can have up to 7 panels.
This function returns the current state of a specifed panel on the vehicle. A vehicle can have up to 7 panels.
Line 6: Line 5:
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
int getVehiclePanelState ( vehicle thevehicle, int panel )
int getVehiclePanelState ( vehicle theVehicle, int panel )
</syntaxhighlight>  
</syntaxhighlight>  
{{OOP||[[vehicle]]:getPanelState||setVehiclePanelState}}


==Required Arguments==
==Required Arguments==
*'''theVehicle:''' A handle to the [[vehicle]] that you wish to know the panel state of.
*'''theVehicle:''' the [[vehicle]] that you wish to know the panel state of.
*'''panel:''' A whole number ranging from 0 to 6.
*'''panel:''' an ''integer'' specifying the panel you want to know the state of. Not every vehicle has every panel. Possible values are:
** '''0:''' Front-left panel
** '''1:''' Front-right panel
** '''2:''' Rear-left panel
** '''3:''' Rear-right panel
** '''4:''' Windscreen
** '''5:''' Front bumper
** '''6:''' Rear bumper


==Returns==
==Returns==
Returns an [[int]] indicating the state of the specified the panel. This value can be:
Returns an [[int]] indicating the state of the specified the panel. This is a value between 0 and 3, with 0 indicating the panel is undamaged and 3 indicating it is very damaged.
 
NEEDS UPDATING


==Example==
==Example==
This function creates an admiral and outputs every panel's state in the chatbox.
This function creates an admiral and outputs every panel's state in the chatbox.
<syntaxhighlight lang="lua">local newcar = createVehicle ( 520, 1024, 1024, 1024 )
<syntaxhighlight lang="lua">
admiral = createVehicle ( 445, 0, 0, 10 )
local admiral = createVehicle ( 445, 0, 0, 10 )
 
...
 
for i=0, 6 do
for i=0, 6 do
  local panel = getVehiclePanelState ( admiral, i )
    local panel = getVehiclePanelState ( admiral, i )
     outputChatBox ( panel )
     outputChatBox ( tostring ( panel ) )
end
end
</syntaxhighlight>
</syntaxhighlight>

Latest revision as of 00:25, 7 April 2018

This function returns the current state of a specifed panel on the vehicle. A vehicle can have up to 7 panels.

Syntax

int getVehiclePanelState ( vehicle theVehicle, int panel )

OOP Syntax Help! I don't understand this!

Method: vehicle:getPanelState(...)
Counterpart: setVehiclePanelState


Required Arguments

  • theVehicle: the vehicle that you wish to know the panel state of.
  • panel: an integer specifying the panel you want to know the state of. Not every vehicle has every panel. Possible values are:
    • 0: Front-left panel
    • 1: Front-right panel
    • 2: Rear-left panel
    • 3: Rear-right panel
    • 4: Windscreen
    • 5: Front bumper
    • 6: Rear bumper

Returns

Returns an int indicating the state of the specified the panel. This is a value between 0 and 3, with 0 indicating the panel is undamaged and 3 indicating it is very damaged.

Example

This function creates an admiral and outputs every panel's state in the chatbox. 

local admiral = createVehicle ( 445, 0, 0, 10 )
for i=0, 6 do
    local panel = getVehiclePanelState ( admiral, i )
    outputChatBox ( tostring ( panel ) )
end

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/GetVehiclePanelState?oldid=54607"