ResetVehicleExplosionTime: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(New page: {{Server function}} __NOTOC__ Resets the vehicle explosion time ==Syntax== <syntaxhighlight lang="lua"> bool resetVehicleExplosionTime ( vehicle theVehicle ) </syntaxhighlight> ===Required Arguments=== *'''theV...)
 
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Server function}}
{{Server function}}
__NOTOC__
__NOTOC__
Resets the vehicle explosion time
Resets the vehicle explosion time. This is the point in time at which the vehicle last exploded: at this time plus the vehicle's respawn delay, the vehicle is respawned. You can use this function to prevent the vehicle from respawning.


==Syntax==  
==Syntax==  
Line 15: Line 15:


==Example==
==Example==
This example resets every vehicle's explosion time when the resource is stopped.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--TODO
function resetVehiclesExplosionTime ()
local vehicles = getElementsByType ( "vehicle" ) -- Return all the vehicles in a table
for k, vehicle in ipairs ( vehicles ) do -- For every vehicle do the following...
resetVehicleExplosionTime ( vehicle ) -- Reset the vehicle's explosion time
end
end
-- When this resource is stopped, trigger the resetVehiclesExplosionTime function (above).
addEventHandler ( "onResourceStop", resourceRoot, resetVehiclesExplosionTime )
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{Vehicle functions}}
{{Vehicle_functions|server}}
[[Category:Needs_Example]]

Latest revision as of 23:04, 6 September 2024

Resets the vehicle explosion time. This is the point in time at which the vehicle last exploded: at this time plus the vehicle's respawn delay, the vehicle is respawned. You can use this function to prevent the vehicle from respawning.

Syntax

bool resetVehicleExplosionTime ( vehicle theVehicle )

Required Arguments

  • theVehicle: The vehicle you wish to reset the explosion time from.

Returns

Returns true if the vehicle explosion time has been reset, false if it failed to reset the explosion time.

Example

This example resets every vehicle's explosion time when the resource is stopped.

function resetVehiclesExplosionTime ()
	local vehicles = getElementsByType ( "vehicle" ) -- Return all the vehicles in a table
		for k, vehicle in ipairs ( vehicles ) do -- For every vehicle do the following...
			resetVehicleExplosionTime ( vehicle ) -- Reset the vehicle's explosion time
		end
end
-- When this resource is stopped, trigger the resetVehiclesExplosionTime function (above).
addEventHandler ( "onResourceStop", resourceRoot, resetVehiclesExplosionTime )

See Also