ResetVehicleIdleTime: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Forgot the 'See Also')
(Added an example.)
Line 15: Line 15:


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


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

Revision as of 20:12, 23 February 2010

Resets the vehicle idle time

Syntax

bool resetVehicleIdleTime ( vehicle theVehicle )

Required Arguments

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

Returns

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

Example

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

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

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/ResetVehicleIdleTime?oldid=22469"