SetVehicleDoorState: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Clarified some things.)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Server client function}}
{{Server client function}}
This function sets the damage state of a specified door on a vehicle.
This function sets the state of the specified door on a vehicle.


==Syntax==
==Syntax==
Line 10: Line 10:
==Required Arguments==
==Required Arguments==
*'''theVehicle:''' 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, 0 (hood), 1 (trunk), 2 (front left), 3 (front right), 4 (rear left), 5 (rear right)
*'''door:''' An integer representing which door to set the state of. Valid values are:
*'''state:''' An integer determining the new state of the door:
**'''0:''' Hood
**'''0:''' intact
**'''1:''' Trunk
**'''1:''' swinging free
**'''2:''' Front left
**'''2:''' bashed
**'''3:''' Front right
**'''3:''' bashed and swinging free
**'''4:''' Rear left
**'''4:''' missing
**'''5:''' Rear right
*'''state:''' An integer representing the state to set the door to. Valid values are:
**'''0:''' Shut, intact
**'''1:''' Ajar, intact
**'''2:''' Shut, damaged
**'''3:''' Ajar, damaged
**'''4:''' Missing


==Returns==
==Returns==
Returns ''true'' if the door state was successfully set, ''false'' if invalid arguments, invalid door IDs or invalid state IDs are passed.
Returns ''true'' if the door state was successfully set, ''false'' otherwise.


==Example==
==Example==

Revision as of 05:25, 24 December 2011

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

Syntax

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

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
    • 1: Ajar, intact
    • 2: Shut, damaged
    • 3: Ajar, 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