Blip::routeFor: Difference between revisions
mNo edit summary |
No edit summary |
||
| (4 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
__TOC__ | |||
{{ServersideJsFunction}} | |||
Creates a route to the blip from the player's location. | |||
{{JSContainer| | |||
==Syntax== | ==Syntax== | ||
< | <pre> | ||
blip.routeFor( | blip.routeFor(player, color, scale); | ||
</pre> | |||
</ | |||
===Required Arguments=== | ===Required Arguments=== | ||
*'''player | *'''player:'''' Player object or an array of player objects | ||
*''' | *'''color:''' {{RageType|Int}} ''(All colors available on [[Blips#Blip_colors|Blip Colors]] page)'' | ||
*'''scale:''' | *'''scale:''' {{RageType|Float}} | ||
==Example== | ==Example== | ||
This example will create a command for creating blip and add route to the player who entered it: | |||
{{ServersideCode| | |||
<pre> | |||
< | |||
mp.events.addCommand("routeBlip", (player) => { | mp.events.addCommand("routeBlip", (player) => { | ||
const position = player.position; | const position = player.position; | ||
| Line 24: | Line 26: | ||
blip.routeFor(player, 2, 1); | blip.routeFor(player, 2, 1); | ||
}); | }); | ||
</ | </pre> | ||
}} | |||
}} | |||
==See Also== | ==See Also== | ||
{{ | {{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
- Functions
- Properties