SetVehicleDoorState: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Add spawnFlyingComponent)
Line 6: Line 6:
<syntaxhighlight lang="lua">bool setVehicleDoorState ( vehicle theVehicle, int door, int state )</syntaxhighlight>
<syntaxhighlight lang="lua">bool setVehicleDoorState ( vehicle theVehicle, int door, int state )</syntaxhighlight>
{{OOP||[[vehicle]]:setDoorState||getVehicleDoorState}}
{{OOP||[[vehicle]]:setDoorState||getVehicleDoorState}}
{{New feature/item|9.0160|1.6.0|20319|
<syntaxhighlight lang="lua">bool setVehicleDoorState ( vehicle theVehicle, int door, int state [, bool spawnFlyingComponent = true ] )</syntaxhighlight>
}}


==Required Arguments==
==Required Arguments==
Line 22: Line 26:
**'''3:''' Ajar, damaged (aka Slightly open, damaged)
**'''3:''' Ajar, damaged (aka Slightly open, damaged)
**'''4:''' Missing
**'''4:''' Missing
===Optional Arguments===
{{OptionalArg}}
{{New feature/item|9.0160|1.6.0|20319|
*'''spawnFlyingComponent:''' A boolean, if set to true, spawns flying doors etc. if you remove a component and <nowiki>state == 4</nowiki>.
}}


==Returns==
==Returns==

Revision as of 14:23, 14 October 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


ADDED/UPDATED IN VERSION 1.6.0 r20319:
bool setVehicleDoorState ( vehicle theVehicle, int door, int state [, bool spawnFlyingComponent = true ] )

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

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.

ADDED/UPDATED IN VERSION 1.6.0 r20319:
  • spawnFlyingComponent: A boolean, if set to true, spawns flying doors etc. if you remove a component and state == 4.

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


Retrieved from "https://wiki.multitheftauto.com/wiki/SetVehicleDoorState?oldid=64519"