GetVehicleColor: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (Changed set to get (function name doesn't involving setting anything))
Line 5: Line 5:
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
int int int int getVehicleColor ( vehicle theVehicle )             
int int int int getVehicleColor ( vehicle theVehicle, bool bRGB)             
</syntaxhighlight>  
</syntaxhighlight>  
{{OOP||[[vehicle]]:getColor}}
{{OOP||[[vehicle]]:getColor}}
===Required Arguments===  
===Required Arguments===  
*'''theVehicle:''' the [[vehicle]] element.
*'''theVehicle:''' the [[vehicle]] element.
 
*'''bRGB :''' A boolean specifying whether to return RGB values. A setting of ''false'' will result in the function returning color ids instead.
===Returns===
===Returns===
Returns 4 [[int|ints]] indicating the color of the vehicle. Returns ''false'' if the vehicle doesn't exist.
Returns 4 [[int|ints]] indicating the color of the vehicle if bRGB argument is false. Returns ''false'' if the vehicle doesn't exist.
 
Valid color ids:
Valid color ids:
{{Vehicle_colors}}
{{Vehicle_colors}}
<br>
 
{{New feature|3.0110|1.1|
{{New feature|3.0110|1.1|
From 1.1, as well as the above syntax, colors can also be retrieved as RGB values:
Returns 12 [[int|ints]] in RGB format if bRGB argument is set to true.Returns ''false'' if the vehicle doesn't exist.
==Syntax==
<syntaxhighlight lang="lua">
int, int, int, int, int, int, int, int, int, int, int, int = getVehicleColor ( vehicle theVehicle, bool bRGB )
</syntaxhighlight>
 
===Required Arguments===
*'''theVehicle:''' The [[vehicle]] that you wish to get the color of.
*'''bRGB :''' A boolean specifying whether to return RGB values. A setting of ''false'' will result in the function returning color ids instead.
 
===Returns===
*Returns 12 [[int|ints]] (if bRGB is ''true'') indicating the red, green and blue components of each of the 4 vehicle colors.
*Returns 4 [[int|ints]] (if bRGB is ''false'') indicating the color ids of each of the 4 vehicle colors.
*Returns ''false'' if the vehicle doesn't exist.


}}
}}

Revision as of 17:19, 14 July 2017

This function returns the color of the specified vehicle. A vehicle can have up to four colors.

Syntax

int int int int getVehicleColor ( vehicle theVehicle, bool bRGB)

OOP Syntax Help! I don't understand this!

Method: vehicle:getColor(...)


Required Arguments

  • theVehicle: the vehicle element.
  • bRGB : A boolean specifying whether to return RGB values. A setting of false will result in the function returning color ids instead.

Returns

Returns 4 ints indicating the color of the vehicle if bRGB argument is false. Returns false if the vehicle doesn't exist. Valid color ids:

0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99
100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119
120 121 122 123 124 125 126

Returns 12 ints in RGB format if bRGB argument is set to true.Returns false if the vehicle doesn't exist.

Example

Click to collapse [-]
Server

This will output the 4 colors of any car that the player enters. 

function playerEnterVehicle ( theVehicle, seat, jacked )
    -- Get the colors of the car and store them to 4 seperate variables
    local color1, color2, color3, color4 = getVehicleColor ( theVehicle )
    -- Output the four retrieved car colors into the chatbox
    outputChatBox ( "Car color 1: " .. color1 )
    outputChatBox ( "Car color 2: " .. color2 )
    outputChatBox ( "Car color 3: " .. color3 )
    outputChatBox ( "Car color 4: " .. color4 )
end
addEventHandler ( "onPlayerVehicleEnter", getRootElement(), playerEnterVehicle )

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/GetVehicleColor?oldid=51646"