SetVehiclePanelState: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
 
Line 36: Line 36:
==Optional Arguments==
==Optional Arguments==
{{New feature/item|3.0161|1.6.0|22868|
{{New feature/item|3.0161|1.6.0|22868|
*'''spawnFlyingComponent:''' If set to '''true''', spawns flying bumpers etc. If you remove a component with state == 3.
*'''spawnFlyingComponent:''' If set to '''true''', spawns flying bumpers etc. If you remove a component with state 3.
9'''breakGlass:''' This argument applies only to the windscreen (PanelID == 4). If set to '''false''', the glass will fall off as a flying component, similar to how a bumper does. If set to '''true''', the windscreen will not spawn as a flying component but will shatter instead, just like when shot.
*'''breakGlass:''' This argument applies only to the windscreen (PanelID is 4). If set to '''false''', the glass will fall off as a flying component, similar to how a bumper does. If set to '''true''', the windscreen will not spawn as a flying component but will shatter instead, just like when shot.
}}
}}


Latest revision as of 18:30, 31 December 2024

This function allows you to change the state of one of the six panels vehicle's can have. When executed on the server-side resources, the damage will be synched for all players, whereas the change is only client-side if the function is used in a client resource.

Syntax

bool setVehiclePanelState ( vehicle theVehicle, int panelID, int state [, bool spawnFlyingComponent = true, bool breakGlass = false ] )

OOP Syntax Help! I don't understand this!

Method: vehicle:setPanelState(...)
Counterpart: getVehiclePanelState


Required Arguments

  • theVehicle: The vehicle you would like to modify the panel of.
  • panelID: An ID specifying the part of the vehicle. Possible values are:
  • Cars:
    • 0: Front-left panel
    • 1: Front-right panel
    • 2: Rear-left panel
    • 3: Rear-right panel
    • 4: Windscreen
    • 5: Front bumper
    • 6: Rear bumper
  • Planes:
    • 0: Engine Smoke (left engine for a Nevada or a Beagle)
    • 1: Engine Smoke (right engine for a Nevada or a Beagle)
    • 2: Rudder
    • 3: Elevators
    • 4: Ailerons
    • 5: Unknown
    • 6: Unknown

NOTE: Settings are not applicable for all vehicles of these types, for instance panel 0 effects a Dodo, but does nothing to a hydra.

  • state: How damaged the part is on the scale of 0 to 3, with 0 being undamaged and 3 being very damaged. How this is manifested depends on the panel and the vehicle.

Optional Arguments

ADDED/UPDATED IN VERSION 1.6.0 r22868:
  • spawnFlyingComponent: If set to true, spawns flying bumpers etc. If you remove a component with state 3.
  • breakGlass: This argument applies only to the windscreen (PanelID is 4). If set to false, the glass will fall off as a flying component, similar to how a bumper does. If set to true, the windscreen will not spawn as a flying component but will shatter instead, just like when shot.

Returns

Returns true if the panel state has been updated, false otherwise

Example

Click to collapse [-]
Example 1: Server
-- create a new vehicle
local newcar = createVehicle ( 520, 1024, 1024, 1024 )
-- break the front bumper off
setVehiclePanelState ( newcar, 5, 3 )

Changelog

Version Description
1.6.0-9.22868 Added spawnFlyingComponent and breakGlass arguments

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/SetVehiclePanelState?oldid=81590"