Blip::getColour: Difference between revisions

From RAGE Multiplayer Wiki
mNo edit summary
No edit summary
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
Property to return the colour value of the blip.
Function to return the colour value of the blip.


== Syntax ==
== Syntax ==
 
<pre>
<syntaxhighlight lang="javascript">
blip.getColour();
blip.getColour();
</syntaxhighlight>
</pre>


=== Return Value ===
=== Return Value ===
*'''Number'''
* {{RageType|Number}}


== Examples ==
== Examples ==
Retrieving the colour value from the blip called policeBlip
Retrieving the colour value from the blip called policeBlip
<div class="header" style="background-color: #AE4040; color: #FFFFFF; border: 2px solid #AE4040;">
{{ClientsideCode|
<div style="margin: 10px 10px 10px 10px;"><b>Client-Side</b></div>
<pre>
<syntaxhighlight lang="javascript">
let policeBlip = mp.blips.new(60, new mp.Vector3(407.95, -961.05, 0), {
let policeBlip = mp.blips.new(60, new mp.Vector3(407.95, -961.05, 0),
     color: 3,
     {
    shortRange: true,
        color: 3,
        shortRange: true,
});
});


let getBlipColour = policeBlip.getColour();
let getBlipColour = policeBlip.getColour();
 
mp.gui.chat.push("Colour: " + getBlipColour); //Output: "Colour: 3"
mp.gui.chat.push("Colour: " + getBlipColour);
</pre>
//Output: "Colour: 3"
}}
</syntaxhighlight>
</div>


==See also==
==See also==
Line 32: Line 27:
[[Category:Clientside API]]
[[Category:Clientside API]]
[[Category:Blip API]]
[[Category:Blip API]]
[[Category:Client-side Function]]

Latest revision as of 08:23, 6 May 2019

Function to return the colour value of the blip.

Syntax

blip.getColour();

Return Value

  • Number

Examples

Retrieving the colour value from the blip called policeBlip

Client-Side
let policeBlip = mp.blips.new(60, new mp.Vector3(407.95, -961.05, 0), {
    color: 3,
    shortRange: true,
});

let getBlipColour = policeBlip.getColour();
mp.gui.chat.push("Colour: " + getBlipColour); //Output: "Colour: 3"

See also