SetVehicleDoorState: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (Added OOP syntax.)
Line 17: Line 17:
**'''5:''' Rear right
**'''5:''' Rear right
*'''state:''' An integer representing the state to set the door to. Valid values are:
*'''state:''' An integer representing the state to set the door to. Valid values are:
**'''0:''' Shut, intact
**'''0:''' Shut, intact (aka Closed, undamaged)
**'''1:''' Ajar, intact
**'''1:''' Ajar, intact (aka Slightly open, undamaged)
**'''2:''' Shut, damaged
**'''2:''' Shut, damaged (aka Closed, damaged)
**'''3:''' Ajar, damaged
**'''3:''' Ajar, damaged (aka Slightly open, damaged)
**'''4:''' Missing
**'''4:''' Missing



Revision as of 13:01, 29 January 2019

This function sets the state of the specified door on a vehicle.

Syntax

bool setVehicleDoorState ( vehicle theVehicle, int door, int state )

OOP Syntax Help! I don't understand this!

Method: vehicle:setDoorState(...)
Counterpart: getVehicleDoorState


Required Arguments

  • theVehicle: The vehicle that you wish to change the door state of.
  • door: An integer representing which door to set the state of. Valid values are:
    • 0: Hood
    • 1: Trunk
    • 2: Front left
    • 3: Front right
    • 4: Rear left
    • 5: Rear right
  • state: An integer representing the state to set the door to. Valid values are:
    • 0: Shut, intact (aka Closed, undamaged)
    • 1: Ajar, intact (aka Slightly open, undamaged)
    • 2: Shut, damaged (aka Closed, damaged)
    • 3: Ajar, damaged (aka Slightly open, damaged)
    • 4: Missing

Returns

Returns true if the door state was successfully set, false otherwise.

Example

-- create a new vehicle
local newcar = createVehicle ( 520, 1024, 1024, 1024 )
-- break its front left door off
state = setVehicleDoorState ( newcar, 2, 4 )

See Also