Class Blip

Inheritance

Object

PoolObject

Blip

Implements

INativeValue

IDeletable

IExistable

Inherited Members

PoolObject.Handle

PoolObject.NativeValue

Object.ToString()

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetType()

Object.MemberwiseClone()

Namespace: GTA

Assembly: ScriptHookVDotNet3.dll

Syntax

public sealed class Blip : PoolObject, INativeValue, IDeletable, IExistable

Constructors

Blip(Int32)

Declaration

public Blip(int handle)

Parameters

Type	Name	Description
Int32	handle

Properties

Alpha

Gets or sets the alpha of this Blip on the map. The value is up to 255.

Declaration

public int Alpha { get; set; }

Property Value

Type	Description
Int32

CategoryType

Gets or sets the category type of this Blip.

Declaration

public BlipCategoryType CategoryType { get; set; }

Property Value

Type	Description
BlipCategoryType

Color

Gets or sets the color of this Blip.

Declaration

public BlipColor Color { get; set; }

Property Value

Type	Description
BlipColor

DisplayNameHash

Get or sets this Blips display name hash. When Name is not set, the game will show the localized String from the games language files with a specified GXT key hash.

Declaration

public int DisplayNameHash { get; set; }

Property Value

Type	Description
Int32

Remarks

Setting Sprite will reset this value.

DisplayType

Gets or sets the display type of this Blip.

Declaration

public BlipDisplayType DisplayType { get; set; }

Property Value

Type	Description
BlipDisplayType

Entity

Gets the Entity this Blip is attached to.

Declaration

public Entity Entity { get; }

Property Value

Type	Description
Entity

FlashInterval

Gets or sets the interval in ms between each blip flashing. The value is up to 65535.

Declaration

public int FlashInterval { get; set; }

Property Value

Type	Description
Int32

FlashTimeLeft

Gets or sets the flash time left in ms before this Blip stops flashing. The max value is up to 65534. Set -1 to let the Blip flash forever.

Declaration

public int FlashTimeLeft { get; set; }

Property Value

Type	Description
Int32

Remarks

returns -1 if the internal value of this property value is set to 65535, which indicates that the flash timer is explicitly not set.

IsFlashing

Gets or sets a value indicating whether this Blip is flashing.

Declaration

public bool IsFlashing { get; set; }

Property Value

Type	Description
Boolean	true if this Blip is flashing; otherwise, false.

IsFriendly

Sets a value indicating whether this Blip is friendly.

Declaration

public bool IsFriendly { set; }

Property Value

Type	Description
Boolean	true if this Blip is friendly; otherwise, false.

IsHiddenOnLegend

Gets or sets a value indicating whether this Blip is hidden on the map legend.

Declaration

public bool IsHiddenOnLegend { get; set; }

Property Value

Type	Description
Boolean	true if this Blip is hidden on the map legend; otherwise, false.

IsOnMinimap

Gets a value indicating whether this Blip is on minimap.

Declaration

public bool IsOnMinimap { get; }

Property Value

Type	Description
Boolean	true if this Blip is on minimap; otherwise, false.

IsShortRange

Gets or sets a value indicating whether this Blip is short range.

Declaration

public bool IsShortRange { get; set; }

Property Value

Type	Description
Boolean	true if this Blip is short range; otherwise, false.

MemoryAddress

Gets the memory address where the Entity is stored in memory.

Declaration

public IntPtr MemoryAddress { get; }

Property Value

Type	Description
IntPtr

Name

Get or sets the custom name of this Blip. The custom name appears in the legends list on the map.

Declaration

public string Name { get; set; }

Property Value

Type	Description
String

Remarks

Returns null if the Blip does not exist. Setting Sprite will clear this name.

See Also

DisplayNameHash

NumberLabel

Gets or sets this Blips label to the given number.

Declaration

public int NumberLabel { get; set; }

Property Value

Type	Description
Int32

Remarks

returns -1 if the internal value of this property value is between 0x80 to 0xFF.

Position

Gets or sets the position of this Blip.

Declaration

public Vector3 Position { get; set; }

Property Value

Type	Description
Vector3

Priority

Gets or sets the priority of this Blip. Overlapping Blips with a higher priority cover those with a smaller one. The value is up to 255.

Declaration

public int Priority { get; set; }

Property Value

Type	Description
Int32

Rotation

Gets or sets the rotation of this Blip on the map as an Int32.

Use RotationFloat instead if you need to get or set the value precisely, since a rotation value of a Blip are stored as a Single in v1.0.944.2 or later versions.

Declaration

public int Rotation { get; set; }

Property Value

Type	Description
Int32	The rotation as an Int32.

See Also

RotationFloat

RotationFloat

Gets or sets the rotation of this Blip on the map as a Single. The value does not have any decimal places in v1.0.877.1 or earlier versions because the value is stored as UInt16 in these versions.

Declaration

public float RotationFloat { get; set; }

Property Value

Type	Description
Single	The rotation as a Single.

Scale

Sets the scale of this Blip on the map.

Declaration

public float Scale { set; }

Property Value

Type	Description
Single

ScaleX

Gets or sets the x-axis scale of this Blip on the map. The value is the same as ScaleY in v1.0.393.4 or earlier versions.

Declaration

public float ScaleX { get; set; }

Property Value

Type	Description
Single

ScaleY

Gets or sets the y-axis scale of this Blip on the map. The value is the same as ScaleX in v1.0.393.4 or earlier versions.

Declaration

public float ScaleY { get; set; }

Property Value

Type	Description
Single

SecondaryColor

Gets or sets the secondary color of this Blip.

Declaration

public Color SecondaryColor { get; set; }

Property Value

Type	Description
Color

ShowRoute

Gets or sets a value indicating whether the route to this Blip should be shown on the map.

Declaration

public bool ShowRoute { get; set; }

Property Value

Type	Description
Boolean	true to show the route; otherwise, false.

ShowsCrewIndicator

Gets or sets a value indicating whether this Blip shows crew member indicator, which highlights the Blip by a left half cyan circle. The right half cyan circle indicator is used to indicate crew members in GTA: Online.

Declaration

public bool ShowsCrewIndicator { get; set; }

Property Value

Type	Description
Boolean	true to show crew member indicator; otherwise, false.

ShowsDollarSign

Gets or sets a value indicating whether this Blip shows the dollar sign at the top left corner of the Blip.

Declaration

public bool ShowsDollarSign { get; set; }

Property Value

Type	Description
Boolean	true to show the dollar sign; otherwise, false.

ShowsFriendIndicator

Gets or sets a value indicating whether this Blip shows friend indicator, which highlights the Blip by a right half cyan circle. The right half cyan circle indicator is used to indicate friends in GTA: Online.

Declaration

public bool ShowsFriendIndicator { get; set; }

Property Value

Type	Description
Boolean	true to show friend indicator; otherwise, false.

ShowsHeadingIndicator

Gets or sets a value indicating whether this Blip shows the heading indicator used for normal players in GTA: Online.

Declaration

public bool ShowsHeadingIndicator { get; set; }

Property Value

Type	Description
Boolean	true to show the heading indicator; otherwise, false.

ShowsOutlineIndicator

Gets or sets a value indicating whether this Blip shows outline. The outline color can be changed by setting SecondaryColor.

Declaration

public bool ShowsOutlineIndicator { get; set; }

Property Value

Type	Description
Boolean	true to show outline; otherwise, false.

Sprite

Gets or sets the sprite of this Blip.

Declaration

public BlipSprite Sprite { get; set; }

Property Value

Type	Description
BlipSprite

Type

Gets the type of this Blip.

Declaration

public int Type { get; }

Property Value

Type	Description
Int32

Methods

Delete()

Removes this Blip.

Declaration

public override void Delete()

Overrides

PoolObject.Delete()

Equals(Object)

Determines if an Object refers to the same blip as this Blip.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
Object	obj	The Object to check.

Returns

Type	Description
Boolean	true if the obj is the same blip as this Blip; otherwise, false.

Overrides

Object.Equals(Object)

Exists()

Determines if this Blip exists.

Declaration

public override bool Exists()

Returns

Type	Description
Boolean	true if this Blip exists; otherwise, false.

Overrides

PoolObject.Exists()

GetAppropriateName()

Gets the appropriate name of this Blip in the same way the game does.

Declaration

public string GetAppropriateName()

Returns

Type	Description
String	The same String as Name if the custom string is set; otherwise, the localized String from the games language files with the same GXT key hash as DisplayNameHash.

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
Int32

Overrides

Object.GetHashCode()

RemoveNumberLabel()

Removes the number label from this Blip.

Declaration

public void RemoveNumberLabel()

ResetName()

Sets the name of this Blip based on its current Sprite.

Declaration

public void ResetName()

Operators

Equality(Blip, Blip)

Determines if two Blips refer to the same blip.

Declaration

public static bool operator ==(Blip left, Blip right)

Parameters

Type	Name	Description
Blip	left	The left Pickup.
Blip	right	The right Pickup.

Returns

Type	Description
Boolean	true if left is the same blip as right; otherwise, false.

Implicit(Blip to InputArgument)

Converts a Blip to a native input argument.

Declaration

public static implicit operator InputArgument(Blip value)

Parameters

Type	Name	Description
Blip	value

Returns

Type	Description
InputArgument

Inequality(Blip, Blip)

Determines if two Blips don't refer to the same blip.

Declaration

public static bool operator !=(Blip left, Blip right)

Parameters

Type	Name	Description
Blip	left	The left Pickup.
Blip	right	The right Pickup.

Returns

Type	Description
Boolean	true if left is not the same blip as right; otherwise, false.

Implements

INativeValue

IDeletable

IExistable