Latest revision as of 09:51, 21 February 2022

JavaScript

Creates a blip to display on your map & minimap. Blips created server-side seem to be impossible to attach to the map. If you create the same blip server-side and client-side, only the second will stay attached to the map (the scale won't change if you zoom in or out).

For client-side usage, be sure that the handle is loaded (blip.handle > 0) before editing blip by any of RAGE functions / natives.

JavaScript Syntax

Syntax

mp.blips.new(sprite, position,
{
    name: name,
    scale: scale,
    color: color,
    alpha: alpha,
    drawDistance: drawDistance,
    shortRange: shortRange,
    rotation: rotation,
    dimension: dimension,
    radius: radius,
});

Parameters

*sprite: Int (Blip sprites)
*position: Vector3
name: String
scale: Float: How big the blip shows on the map
color: Color ID (Blip colors)
alpha: Int [0:255]
drawDistance: Float
shortRange: Boolean: If it's hidden in the minimap until the player is close
rotation: Float
dimension: Int
radius: Float

Example

This creates a blip at the police station. The blip is assigned to the variable policeBlip.

Shared

let policeBlip = mp.blips.new(60, new mp.Vector3(427.95, -981.05, 0),
    {
        name: 'Los Santos Police Station',
        color: 3,
        shortRange: true,
});

@@ Line 1: / Line 1: @@
-__NOTOC__
+{{SharedFunctionJS}}
-'''Function''': Creates a blip.
-==Parameters==
+Creates a blip to display on your map & minimap.
-*'''sprite''': {{RageType|Int}} ([[Blips#Blip_model|Blip sprites]])
+Blips created server-side seem to be impossible to attach to the map. If you create the same blip server-side and client-side, only the second will stay attached to the map (the scale won't change if you zoom in or out).
-*'''position''': {{RageType|Vector3}}
-*'''name''': {{RageType|String}}
+For client-side usage, be sure that the handle is loaded (blip.handle > 0) before editing blip by any of RAGE functions / natives.
-*'''scale''': {{RageType|Float}}
-*'''color''': {{RageType|Color ID}} ([[Blips#Blip_colors|Blip colors]])
+{{JSContainer|
-*'''alpha''': {{RageType|Int}} [0:255]
+== Syntax ==
-*'''drawDistance''': {{RageType|Float}}
-*'''shortRange''': {{RageType|Boolean}}: Auto-hide on the minimap
-*'''rotation''': {{RageType|Vector3}}
-*'''dimension''': {{RageType|Int}}
-==Syntax==
+<pre>
-<syntaxhighlight lang="javascript">
 mp.blips.new(sprite, position,
 {
@@ Line 25: / Line 20: @@
      rotation: rotation,
      dimension: dimension,
+    radius: radius,
 });
-</syntaxhighlight>
+</pre>
+=== Parameters ===
+*'''{{Required}}sprite''': {{RageType|Int}} ([[Blips#Blip_model|Blip sprites]])
+*'''{{Required}}position''': {{RageType|Vector3}}
+*'''name''': {{RageType|String}}
+*'''scale''': {{RageType|Float}}: How big the blip shows on the map
+*'''color''': {{RageType|Color ID}} ([[Blips#Blip_colors|Blip colors]])
+*'''alpha''': {{RageType|Int}} [0:255]
+*'''drawDistance''': {{RageType|Float}}
+*'''shortRange''': {{RageType|Boolean}}: If it's hidden in the minimap until the player is close
+*'''rotation''': {{RageType|Float}}
+*'''dimension''': {{RageType|Int}}
+*'''radius''': {{RageType|Float}}
-==Example==
+== Example ==
-<div class="header" style="background-color: #AE4040; color: #FFFFFF; border: 2px solid #AE4040;">
-<div style="margin: 10px 10px 10px 10px;"><b>Client-Side</b></div>
-</div>
-<syntaxhighlight lang="javascript">
-    userBlipVector = new mp.Vector3(x,y,0);
-    userBlip = mp.blips.new(8, userBlipVector);
-</syntaxhighlight>
-==See Also==
+This creates a blip at the police station. The blip is assigned to the variable '''policeBlip'''.
+{{SharedCode|
+<pre>
+let policeBlip = mp.blips.new(60, new mp.Vector3(427.95, -981.05, 0),
+    {
+        name: 'Los Santos Police Station',
+        color: 3,
+        shortRange: true,
+});
+</pre>
+}}
+}}
+== See Also ==
 {{Blip_definition}}
+[[Category:Blip API]]
+[[Category:Shared Function]]