GetVehiclePaintjob: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
No edit summary
 
(4 intermediate revisions by 4 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
This function gets the current paintjob on the specified vehicle. <br/>
{{Server client function}}
Note: Only works for supported vehicles.
This function gets the current paintjob on the specified vehicle. <br />


==Syntax==
==Syntax==
<syntaxhighlight lang="lua">int getVehiclePaintjob ( vehicle theVehicle )</syntaxhighlight>
<syntaxhighlight lang="lua">int getVehiclePaintjob ( vehicle theVehicle )</syntaxhighlight>
 
{{OOP||[[vehicle]]:getPaintjob|paintjob|setVehiclePaintjob}}
===Required Arguments===
===Required Arguments===
*'''theVehicle''': The [[vehicle]] you wish to get the paintjob of.
*'''theVehicle''': the [[vehicle]] you wish to get the paintjob of.


==Returns==
==Returns==
Returns an integer representing the current paintjob on the vehicle. <br/>
Returns an integer representing the current paintjob on the vehicle. <br />
Note: Returns '255' for default (no paintjob/plain).
* '''0''': The first paintjob
* '''1''': The second paintjob
* '''2''': The third paintjob
* '''3''': Default paintjob (no paintjob)
{{Note|Always returns 3 if paintjobs are not supported for the vehicle.}}


==Example==
==Example==
This example will set the paintjob of a new sultan to '2', then check it was set.
This example will set the paintjob of a new sultan to '2', then check it was set.
<syntaxhighlight lang="lua">
<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
paintjob = getVehiclePaintjob ( vehicle )
paintjob = getVehiclePaintjob ( newvehicle )
if ( paintjob == 2 ) then
if ( paintjob == 2 ) then
  outputChatBox ( "the paintjob was successfully set" )
    outputChatBox ( "the paintjob was successfully set" )
end
end
</syntaxhighlight>
</syntaxhighlight>
Line 26: Line 30:
==See Also==
==See Also==
{{Vehicle functions}}
{{Vehicle functions}}
[[pl:getVehiclePaintjob]]

Latest revision as of 04:22, 11 August 2019

This function gets the current paintjob on the specified vehicle.

Syntax

int getVehiclePaintjob ( vehicle theVehicle )

OOP Syntax Help! I don't understand this!

Method: vehicle:getPaintjob(...)
Variable: .paintjob
Counterpart: setVehiclePaintjob


Required Arguments

  • theVehicle: the vehicle you wish to get the paintjob of.

Returns

Returns an integer representing the current paintjob on the vehicle.

  • 0: The first paintjob
  • 1: The second paintjob
  • 2: The third paintjob
  • 3: Default paintjob (no paintjob)
[[{{{image}}}|link=|]] Note: Always returns 3 if paintjobs are not supported for the vehicle.

Example

This example will set the paintjob of a new sultan to '2', then check it was set. 

newvehicle = createVehicle ( 560, 100, 100, 40 )   -- create the sultan
setVehiclePaintjob ( newvehicle, 2 )               -- change the paintjob
paintjob = getVehiclePaintjob ( newvehicle )
if ( paintjob == 2 ) then
    outputChatBox ( "the paintjob was successfully set" )
end

See Also

Retrieved from "https://wiki.multitheftauto.com/wiki/GetVehiclePaintjob?oldid=63669"