GetVehiclePanelState: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
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 11: Line 10:
==Required Arguments==
==Required Arguments==
*'''theVehicle:''' The [[vehicle]] that you wish to know the panel state of.
*'''theVehicle:''' The [[vehicle]] that you wish to know the panel state of.
*'''panel:''' An ''integer'' 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.  
 
NEEDS UPDATING


==Example==
==Example==
Line 30: Line 34:
==See Also==
==See Also==
{{Vehicle functions}}
{{Vehicle functions}}
{{Category:Incomplete}}

Revision as of 00:53, 24 September 2008

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 )

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.

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 ( panel )
end

See Also


This is a list of functions that need to be documented. To list a function as incomplete, add the following to the function's page:

[[Category:Incomplete]]