GetVehiclePaintjob: Difference between revisions
		
		
		
		
		
		Jump to navigation
		Jump to search
		
				
		
		
	
LordAzamath (talk | contribs) mNo edit summary  | 
				 (OOP)  | 
				||
| Line 1: | Line 1: | ||
__NOTOC__  | |||
{{Server client function}}  | {{Server client function}}  | ||
This function gets the current paintjob on the specified vehicle. <br />  | 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''':   | *'''theVehicle''': the [[vehicle]] you wish to get the paintjob of.  | ||
==Returns==  | ==Returns==  | ||
Revision as of 16:12, 13 October 2014
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)
 
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
- addVehicleUpgrade
 - addVehicleSirens
 - attachTrailerToVehicle
 - blowVehicle
 - createVehicle
 - detachTrailerFromVehicle
 - fixVehicle
 - getOriginalHandling
 - getTrainDirection
 - getTrainPosition
 - getTrainSpeed
 - getVehicleColor
 - getVehicleCompatibleUpgrades
 - getVehicleController
 - getVehicleDoorOpenRatio
 - getVehicleDoorState
 - getVehicleEngineState
 - getVehicleHandling
 - getVehicleHeadLightColor
 - getVehicleLandingGearDown
 - getVehicleLightState
 - getVehicleMaxPassengers
 - getVehicleModelFromName
 - getVehicleName
 - getVehicleNameFromModel
 - setVehicleNitroActivated
 - getVehicleOccupant
 - getVehicleOccupants
 - getVehicleOverrideLights
 - getVehiclePaintjob
 - getVehiclePanelState
 - getVehiclePlateText
 - getVehicleSirenParams
 - getVehicleSirens
 - getVehicleSirensOn
 - getVehicleTowedByVehicle
 - getVehicleTowingVehicle
 - getVehicleTurretPosition
 - getVehicleType
 - getVehicleUpgradeOnSlot
 - getVehicleUpgradeSlotName
 - getVehicleUpgrades
 - getVehicleVariant
 - getVehicleWheelStates
 - isTrainDerailable
 - isTrainDerailed
 - isVehicleBlown
 - isVehicleDamageProof
 - isVehicleFuelTankExplodable
 - isVehicleLocked
 - isVehicleOnGround
 - isVehicleTaxiLightOn
 - removeVehicleUpgrade
 - removeVehicleSirens
 - setTrainDerailable
 - setTrainDerailed
 - setTrainDirection
 - setTrainPosition
 - setTrainSpeed
 - setVehicleColor
 - setVehicleDamageProof
 - setVehicleDoorOpenRatio
 - setVehicleDoorState
 - setVehicleDoorsUndamageable
 - setVehicleEngineState
 - setVehicleFuelTankExplodable
 - setVehicleHandling
 - setVehicleHeadLightColor
 - setVehicleLandingGearDown
 - setVehicleLightState
 - setVehicleLocked
 - setVehicleOverrideLights
 - setVehiclePaintjob
 - setVehiclePanelState
 - setVehiclePlateText
 - setVehicleSirens
 - setVehicleSirensOn
 - setVehicleTaxiLightOn
 - setVehicleTurretPosition
 - setVehicleVariant
 - setVehicleWheelStates