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}}
-This function used for create new blip.
-==Syntax==
-<syntaxhighlight lang="javascript">
-mp.blips.new(Number model, Vector3 position [, Number radius]);
-</syntaxhighlight>
-===Returns===
-Return a blip entity, which can be used with blip methods and parameters, like a [[Entity::type|blip.type]], [[Entity::destroy|blip.destroy()]] and others.
-===Required Arguments===
-*'''model:''' ID model. ''(All models available on [[Blips]] page)''
-*'''position:''' Blip position on map.
-*'''radius:''' Blip visible radius.
-==Example==
+Creates a blip to display on your map & minimap.
-That's example will create blip with model ID 140 (Cannabis icon).
+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).
-<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">
+For client-side usage, be sure that the handle is loaded (blip.handle > 0) before editing blip by any of RAGE functions / natives.
-<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>
-<syntaxhighlight lang="javascript">
-let createdBlip = mp.blips.new(140, new mp.Vector3(0, 0, 0));
-</syntaxhighlight>
-</div>
-==See Also==
+{{JSContainer|
-{{Blip_function}}
+== Syntax ==
+<pre>
+mp.blips.new(sprite, position,
+{
+    name: name,
+    scale: scale,
+    color: color,
+    alpha: alpha,
+    drawDistance: drawDistance,
+    shortRange: shortRange,
+    rotation: rotation,
+    dimension: dimension,
+    radius: radius,
+});
+</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 ==
+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]]