SetVehicleDoorState: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
 
(20 intermediate revisions by 13 users not shown)
Line 1: Line 1:
==Description==
__NOTOC__
This function sets the state of a specified door on the vehicle.
{{Server client function}}
This function sets the state of the specified door on a vehicle.


==Syntax==
==Syntax==
<syntaxhighlight lang="lua">setVehicleDoorState ( vehicle, door, state )</syntaxhighlight>
<syntaxhighlight lang="lua">bool setVehicleDoorState ( vehicle theVehicle, int door, int state )</syntaxhighlight>
{{OOP||[[vehicle]]:setDoorState||getVehicleDoorState}}
 
{{New feature/item|9.0158|1.5.8|20319|
<syntaxhighlight lang="lua">bool setVehicleDoorState ( vehicle theVehicle, int door, int state [, bool spawnFlyingComponent = true ] )</syntaxhighlight>
}}


==Required Arguments==
==Required Arguments==
*'''Vehicle:''' A handle to the [[vehicle]] that you wish to change the door state of.
*'''theVehicle:''' The [[vehicle]] that you wish to change the door state of.
*'''Door:''' A whole number between 0 and 5.
*'''door:''' An integer representing which door to set the state of. Valid values are:
*'''State:''' A whole number determining the new state of the door. (0: fine, 2: broken, 4: fallen off)
**'''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===
{{OptionalArg}}
{{New feature/item|9.0158|1.5.8|20319|
{{Note|This parameter doesn't work during the vehicle creation. You need a [[SetTimer]] if you need to create the vehicle using this parameter.}}
*'''spawnFlyingComponent:''' A boolean, if set to true, spawns flying doors etc. if you remove a component with <nowiki>state == 4</nowiki>.
}}
 
==Returns==
Returns ''true'' if the door state was successfully set, ''false'' otherwise.


==Example==
==Example==
<syntaxhighlight lang="lua">newcar = createVehicle ( 520, 1024, 1024, 1024 )
<syntaxhighlight lang="lua">
state = setVehicleDoorState ( newcar, 2, 4 ) -- Breaks the front-left door off of a vehicle.
-- create a new vehicle
local newcar = createVehicle (420, 2472.5, -1688, 13.3)
-- break its front left door off
setVehicleDoorState (newcar, 2, 4)
-- make its hood disapear
setTimer (setVehicleDoorState, 100, 1, newcar, 0, 4, false)
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{Vehicle functions}}
{{Vehicle functions}}

Latest revision as of 17:38, 4 October 2022

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.5.8 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.5.8 r20319:
[[{{{image}}}|link=|]] Note: This parameter doesn't work during the vehicle creation. You need a SetTimer if you need to create the vehicle using this parameter.
  • spawnFlyingComponent: A boolean, if set to true, spawns flying doors etc. if you remove a component with state == 4.

Returns

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

Example

-- create a new vehicle
local newcar = createVehicle (420, 2472.5, -1688, 13.3)
-- break its front left door off
setVehicleDoorState (newcar, 2, 4)
-- make its hood disapear
setTimer (setVehicleDoorState, 100, 1, newcar, 0, 4, false)

See Also


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