SetVehiclePaintjob: Difference between revisions

Latest revision as of 17:13, 15 April 2014

This function changes the paintjob on the specified vehicle.
See paintjob for list of supported vehicles.

bool setVehiclePaintjob ( vehicle theVehicle, int value )

theVehicle: The vehicle you wish to change the paintjob of.
value: A whole number representing the new paintjob id. Ranges from 0 up to 3.

Returns true if the vehicle's paintjob was changed. Otherwise false.

This example will set the paintjob of a new sultan to '2'.

newvehicle = createVehicle ( 560, 100, 100, 40 )  -- create the sultan
setVehiclePaintjob ( newvehicle, 2 )              -- change the paintjob

@@ Line 1: / Line 1: @@
 __NOTOC__
+{{Server client function}}
 This function changes the paintjob on the specified vehicle. <br/>
-Note: Only works for supported vehicles.
+See [[Paintjob|paintjob]] for list of supported vehicles.
 ==Syntax==
-<syntaxhighlight lang="lua">bool setVehiclePaintjob ( vehicle theVehicle, int Value )</syntaxhighlight>
+<syntaxhighlight lang="lua">bool setVehiclePaintjob ( vehicle theVehicle, int value )</syntaxhighlight>
 ===Required Arguments===
 *'''theVehicle''': The [[vehicle]] you wish to change the paintjob of.
-*'''Value''': A whole number representing the new paintjob id.
+*'''value''': A whole number representing the new paintjob id. Ranges from 0 up to 3.
 ==Returns==
-Returns 'true' if the vehicle's paintjob was changed. Otherwise 'false'.
+Returns ''true'' if the vehicle's paintjob was changed. Otherwise ''false''.
 ==Example==
 This example will set the paintjob of a new sultan to '2'.
 <syntaxhighlight lang="lua">
-vehicle = createVehicle ( 560, 100, 100, 40 ) -- create the sultan
+newvehicle = createVehicle ( 560, 100, 100, 40 )  -- create the sultan
-setVehiclePaintjob ( vehicle, 2 ) -- change the paintjob
+setVehiclePaintjob ( newvehicle, 2 )              -- change the paintjob
 </syntaxhighlight>
 ==See Also==
 {{Vehicle functions}}