Blip::routeFor: Difference between revisions

From RAGE Multiplayer Wiki
m (Fixed up page, better description & example)
No edit summary
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
__NOTOC__
__TOC__
{{ServersideJsFunction}}
 
Creates a route to the blip from the player's location.
Creates a route to the blip from the player's location.


{{JSContainer|
==Syntax==
==Syntax==
<pre>
<pre>
blip.routeFor(player, color, scale);
blip.routeFor(player, color, scale);
</pre>  
</pre>  
===Required Arguments===
===Required Arguments===
*'''player:'''' Player object or an array of player objects
*'''player:'''' Player object or an array of player objects
Line 14: Line 18:
This example will create a command for creating blip and add route to the player who entered it:
This example will create a command for creating blip and add route to the player who entered it:


<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">
{{ServersideCode|
<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>
<pre>
<pre>
mp.events.addCommand("routeBlip", (player) => {
mp.events.addCommand("routeBlip", (player) => {
Line 24: Line 27:
});
});
</pre>
</pre>
</div>
}}
}}


==See Also==
==See Also==
{{Blip_definition}}
{{Blip_definition}}

Latest revision as of 12:17, 2 December 2019

Server-Side
Function

 JavaScript



Creates a route to the blip from the player's location.

JavaScript Syntax

Syntax

blip.routeFor(player, color, scale);

Required Arguments

  • player:' Player object or an array of player objects
  • color: Int (All colors available on Blip Colors page)
  • scale: Float

Example

This example will create a command for creating blip and add route to the player who entered it:

Server-Side
mp.events.addCommand("routeBlip", (player) => {
	const position = player.position;
	const blip = mp.blips.new(1, position);

	blip.routeFor(player, 2, 1);
});


See Also