FixVehicle: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
No edit summary
Line 1: Line 1:
[[Category:Incomplete]]
__NOTOC__  
__NOTOC__  
This fake function is for use with blah & blah and does blahblahblabhalbhl
This function will set a [[vehicle]]'s health to full and fix it's damage model. If you wish to just change the vehicle's health, without affecting it's damage model, use [[setVehicleHealth]].


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool fixVehicle ( element vehicle )             
bool fixVehicle ( vehicle theVehicle )             
</syntaxhighlight>  
</syntaxhighlight>  


===Required Arguments===  
===Required Arguments===  
*'''argumentName:''' description
*'''theVehicle:''' The vehicle you wish to fix
 
===Optional Arguments===
{{OptionalArg}}
*'''argumentName2:''' descriptiona
*'''argumentName3:''' description


===Returns===
===Returns===
Returns ''true'' if blah, ''false'' otherwise.
Returns ''true'' if the vehicle was fixed, ''false'' if ''theVehicle'' is invalid.


==Example==  
==Example==  
This example does...
This example fixes all the vehicles that exist in the map.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--This line does...
-- Retrieve a table containing all the vehicles that exist
blabhalbalhb --abababa
vehicles = getElementsByType ( "vehicle" )
--This line does this...
-- Loop through the list, storing the vehicle from the table in the variable vehicleValue
mooo
for vehicleKey, vehicleValue in blips do
-- fix the vehicle
fixVehicle( vehicleHealth )
end
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{FunctionArea_Functions}}
{{Vehicle_functions}}

Revision as of 12:10, 25 May 2006

This function will set a vehicle's health to full and fix it's damage model. If you wish to just change the vehicle's health, without affecting it's damage model, use setVehicleHealth.

Syntax

bool fixVehicle ( vehicle theVehicle )             

Required Arguments

  • theVehicle: The vehicle you wish to fix

Returns

Returns true if the vehicle was fixed, false if theVehicle is invalid.

Example

This example fixes all the vehicles that exist in the map.

-- Retrieve a table containing all the vehicles that exist
vehicles = getElementsByType ( "vehicle" )
-- Loop through the list, storing the vehicle from the table in the variable vehicleValue
for vehicleKey, vehicleValue in blips do
	-- fix the vehicle
	fixVehicle( vehicleHealth )
end

See Also