Blip::getCoords: Difference between revisions

From RAGE Multiplayer Wiki
(Added example, fixed blip definition & changed layout)
No edit summary
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{ClientSide}}
Function to return the coordinates of the blip.
 
Property to return the coordinates value of the blip.


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


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


== Examples ==
== Examples ==
Retrieving the coordinates value from the blip called policeBlip
Retrieving the coordinates value from the blip called policeBlip
 
{{ClientsideCode|
<syntaxhighlight lang="javascript">
<pre>
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,
        color: 3,
    shortRange: true,
        shortRange: true,
});
});


let getBlipCoords = policeBlip.getCoords();
let getBlipCoords = policeBlip.getCoords();


mp.gui.chat.push("Coords: " + JSON.stringify(getBlipCoords));
mp.gui.chat.push("Coords: " + JSON.stringify(getBlipCoords)); //Output: "Coords: {"x":407.95001220703125,"y":-961.0499877929688,"z":0}"
//Output: "Coords: {"x":407.95001220703125,"y":-961.0499877929688,"z":0}"
</pre>
</syntaxhighlight>
}}


==See also==
==See also==
Line 33: Line 28:
[[Category:Clientside API]]
[[Category:Clientside API]]
[[Category:Blip API]]
[[Category:Blip API]]
[[Category:Client-side Function]]

Latest revision as of 08:24, 6 May 2019

Function to return the coordinates of the blip.

Syntax

blip.getCoords();

Return Value

  • Vector3

Examples

Retrieving the coordinates 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 getBlipCoords = policeBlip.getCoords();

mp.gui.chat.push("Coords: " + JSON.stringify(getBlipCoords)); //Output: "Coords: {"x":407.95001220703125,"y":-961.0499877929688,"z":0}"

See also