Vehicle::getNeonColour: Difference between revisions

From RAGE Multiplayer Wiki
m (Added a missing line break in the code for readability purposes.)
No edit summary
 
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{ServersideJsFunction}}
{{ServersideJsFunction}}
This function used for get vehicle neon color in RGB format.
This function is used to get the vehicle's neon colour in an RGB format.


{{JSContainer|
{{JSContainer|
==Syntax==
==Syntax==
<pre>
<pre>
Object vehicle.getNeonColour();
vehicle.getNeonColour();
</pre>
</pre>


===Returns===
===Returns===
Return array containing colours.
*'''neonColours''': {{RageType|Array}} Array containing the colours.
==Array content==
** '''r''': Red [0 - 255]
* Red color in diapason 0 - 255.
** '''g''': Green [0 - 255]
* Green color in diapason 0 - 255.
** '''b''': Blue [0 - 255]
* Blue color in diapason 0 - 255.


==Example==
==Example==
{{ServersideCode|
{{ServersideCode|
<pre>
<pre>
mp.events.addCommand(`neonich`,  
mp.events.addCommand(`getneon`,  
(player) => {
(player) => {
let vehicle = player.vehicle;
let vehicle = player.vehicle;
Line 33: Line 32:


== See Also ==
== See Also ==
*'''Server-side'''
{{Vehicle_function}}
{{Vehicle_function}}

Latest revision as of 00:58, 14 September 2020

Server-Side
Function

 JavaScript



This function is used to get the vehicle's neon colour in an RGB format.

JavaScript Syntax

Syntax

vehicle.getNeonColour();

Returns

  • neonColours: Array Array containing the colours.
    • r: Red [0 - 255]
    • g: Green [0 - 255]
    • b: Blue [0 - 255]

Example

Server-Side
mp.events.addCommand(`getneon`, 
	(player) => {
		let vehicle = player.vehicle;
		if (!!vehicle) {
			let [r, g, b] = vehicle.getNeonColour();
			player.outputChatBox(`R <b>${r}</b>; G <b>${g}</b>; B <b>${b}</b>`);
		};
	}
);


See Also