Multi Theft Auto: Wiki - User contributions [en]

GetVehicleDoorOpenRatio

2011-09-20T21:21:06Z

Will:

__NOTOC__
{{Server client function}}
This function tells you how open a door is (the 'open ratio'). Doors include boots/trunks and bonnets on vehicles that have them.

==Syntax==
<syntaxhighlight lang="lua">
float getVehicleDoorOpenRatio ( vehicle theVehicle, int door )
</syntaxhighlight>

==Required Arguments==
*'''theVehicle:''' The [[vehicle]] that you wish to get the door open ratio of.
*'''door:''' A whole number, 0 (hood), 1 (trunk), 2 (front left), 3 (front right), 4 (rear left), 5 (rear right)

==Returns==
Returns a number between 0 and 1 that indicates how open the door is. 0 is closed, and 1 is fully open. Returns ''false'' if invalid arguments are passed.

==Example==
This example opens all the doors of the vehicle gradually over 2.5 seconds.
<syntaxhighlight lang="lua">
addCommandHandler ( "carshowoff", function ( playerSource )
local vehicle = getPedOccupiedVehicle ( playerSource )
if vehicle then
for i=0,5 do
setVehicleDoorOpenRatio ( vehicle, i, 1 - getVehicleDoorOpenRatio ( vehicle, i ), 2500 )
end
end
end )
</syntaxhighlight>

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

SetVehicleDoorOpenRatio

2011-09-20T21:15:02Z

Will:

__NOTOC__
{{Server client function}}
This function sets how much a vehicle's door is open. Doors include the boot/trunk and the bonnet of the vehicle.

==Syntax==
<syntaxhighlight lang="lua">
bool setVehicleDoorOpenRatio ( vehicle theVehicle, int door, float ratio [, int time ] )
</syntaxhighlight>

==Required Arguments==
*'''theVehicle:''' The [[vehicle]] that you wish to change the door open ratio of.
*'''door:''' A whole number, 0 (hood), 1 (trunk), 2 (front left), 3 (front right), 4 (rear left), 5 (rear right)
*'''ratio:''' The ratio value, ranging from 0 (fully closed) to 1 (fully open).

==Optional Arguments==
{{OptionalArg}}
*'''time:''' The number of milliseconds the door should take to reach the value you have specified. A value of 0 will change the door open ratio instantly.

==Returns==
Returns ''true'' if the door open ratio was successfully set, ''false'' if invalid arguments are passed.

==Example==
This example opens all the doors of the vehicle gradually over 2.5 seconds.
<syntaxhighlight lang="lua">
addCommandHandler ( "carshowoff", function ( playerSource )
local vehicle = getPedOccupiedVehicle ( playerSource )
if vehicle then
for i=0,5 do
setVehicleDoorOpenRatio ( vehicle, i, 1 - getVehicleDoorOpenRatio ( vehicle, i ), 2500 )
end
end
end )
</syntaxhighlight>

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

SetVehicleDoorState

2011-09-09T12:05:01Z

Will: /* Required Arguments */

__NOTOC__
{{Server client function}}
This function sets the damage state of a specified door on a vehicle.

==Syntax==
<syntaxhighlight lang="lua">
bool setVehicleDoorState ( vehicle theVehicle, int door, int state )
</syntaxhighlight>

==Required Arguments==
*'''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)
*'''state:''' An integer determining the new state of the door:
**'''0:''' intact
**'''1:''' swinging free
**'''2:''' bashed
**'''3:''' bashed and swinging free
**'''4:''' missing

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

==Example==
<syntaxhighlight lang="lua">
-- create a new vehicle
local newcar = createVehicle ( 520, 1024, 1024, 1024 )
-- break its front left door off
state = setVehicleDoorState ( newcar, 2, 4 )
</syntaxhighlight>

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