SetVehicleIdleRespawnDelay: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
__NOTOC__
__NOTOC__
This function sets the time delay (in miliseconds) the vehicle will remain at its position while empty.
{{Server function}}
This function sets the time delay (in milliseconds) the vehicle will remain at its position while empty.


==Syntax==
==Syntax==
Line 7: Line 8:
===Required Arguments===
===Required Arguments===
*'''theVehicle''': The [[vehicle]] you wish to change the respawn delay of.
*'''theVehicle''': The [[vehicle]] you wish to change the respawn delay of.
*'''timeDelay''': A number representing the ammount of miliseconds to delay.
*'''timeDelay''': A number representing the amount of milliseconds the vehicle will be allowed to remain unused until it respawns.


==Returns==
==Returns==
Line 13: Line 14:


==Example==
==Example==
This example creates a vehicle and sets it's respawn delay to 20 seconds.
This example creates a vehicle and sets its respawn delay to 20 seconds.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
vehicle = createVehicle ( 400, 1, 1, 1 ) -- create us a new vehicle
theVehicle = createVehicle ( 400, 1, 1, 1 )       -- create us a new vehicle
if ( vehicle ) then
if ( theVehicle ) then
  setVehicleIdleRespawnDelay ( vehicle, 20000 ) -- tell the server to respawn the vehicle 20seconds after its been left.
    setVehicleIdleRespawnDelay ( vehicle, 20000 ) -- tell the server to respawn the vehicle 20 seconds after it's been left.
end
end
</syntaxhighlight>
</syntaxhighlight>

Revision as of 19:27, 15 August 2007

This function sets the time delay (in milliseconds) the vehicle will remain at its position while empty.

Syntax

bool setVehicleIdleRespawnDelay ( vehicle theVehicle, int timeDelay )

Required Arguments

  • theVehicle: The vehicle you wish to change the respawn delay of.
  • timeDelay: A number representing the amount of milliseconds the vehicle will be allowed to remain unused until it respawns.

Returns

Returns 'true' if the vehicle was found and edited.

Example

This example creates a vehicle and sets its respawn delay to 20 seconds.

theVehicle = createVehicle ( 400, 1, 1, 1 )       -- create us a new vehicle
if ( theVehicle ) then
    setVehicleIdleRespawnDelay ( vehicle, 20000 ) -- tell the server to respawn the vehicle 20 seconds after it's been left.
end

See Also