SHVDN  v3
An ASI plugin for Grand Theft Auto V, which allows running scripts written in any .NET language in-game. Developed by crosire https://github.com/crosire/scripthookvdotnet/
GTA.Blip Class Reference
Inheritance diagram for GTA.Blip:
GTA.PoolObject GTA.Native.INativeValue GTA.IDeletable GTA.IExistable

Public Member Functions

 Blip (int handle)
 
void RemoveNumberLabel ()
 Removes the number label from this Blip. More...
 
override void Delete ()
 Removes this Blip. More...
 
override bool Exists ()
 Determines if this Blip exists. More...
 
override bool Equals (object obj)
 Determines if an object refers to the same blip as this Blip. More...
 
override int GetHashCode ()
 

Static Public Member Functions

static bool operator== (Blip left, Blip right)
 Determines if two Blips refer to the same blip. More...
 
static bool operator!= (Blip left, Blip right)
 Determines if two Blips don't refer to the same blip. More...
 
static implicit operator InputArgument (Blip value)
 Converts a Blip to a native input argument. More...
 

Properties

int Type [get]
 Gets the type of this Blip. More...
 
int Alpha [get, set]
 Gets or sets the alpha of this Blip on the map. More...
 
int Priority [set]
 Sets the priority of this Blip. More...
 
int NumberLabel [set]
 Sets this Blips label to the given number. More...
 
BlipColor Color [get, set]
 Gets or sets the color of this Blip. More...
 
BlipSprite Sprite [get, set]
 Gets or sets the sprite of this Blip. More...
 
string Name [set]
 Sets this Blips label to the given string. More...
 
Vector3 Position [get, set]
 Gets or sets the position of this Blip. More...
 
int Rotation [set]
 Sets the rotation of this Blip on the map. More...
 
float Scale [set]
 Sets the scale of this Blip on the map. More...
 
Entity Entity [get]
 Gets the Entity this Blip is attached to. More...
 
bool ShowRoute [set]
 Sets a value indicating whether the route to this Blip should be shown on the map. More...
 
bool IsFriendly [set]
 Sets a value indicating whether this Blip is friendly. More...
 
bool IsFlashing [get, set]
 Gets or sets a value indicating whether this Blip is flashing. More...
 
bool IsOnMinimap [get]
 Gets a value indicating whether this Blip is on minimap. More...
 
bool IsShortRange [get, set]
 Gets or sets a value indicating whether this Blip is short range. More...
 
- Properties inherited from GTA.PoolObject
int Handle [get, protected set]
 The handle of the object. More...
 
ulong NativeValue [get, set]
 The handle of the object translated to a native value. More...
 
- Properties inherited from GTA.Native.INativeValue
ulong NativeValue [get, set]
 

Additional Inherited Members

- Protected Member Functions inherited from GTA.PoolObject
 PoolObject (int handle)
 

Constructor & Destructor Documentation

◆ Blip()

GTA.Blip.Blip ( int  handle)

Member Function Documentation

◆ Delete()

override void GTA.Blip.Delete ( )
virtual

Removes this Blip.

Implements GTA.PoolObject.

◆ Equals()

override bool GTA.Blip.Equals ( object  obj)

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

Parameters
objThe object to check.
Returns
true if the obj is the same blip as this Blip; otherwise, false.

◆ Exists()

override bool GTA.Blip.Exists ( )
virtual

Determines if this Blip exists.

Returns
true if this Blip exists; otherwise, false.

Implements GTA.PoolObject.

◆ GetHashCode()

override int GTA.Blip.GetHashCode ( )

◆ operator InputArgument()

static implicit GTA.Blip.operator InputArgument ( Blip  value)
static

Converts a Blip to a native input argument.

◆ operator!=()

static bool GTA.Blip.operator!= ( Blip  left,
Blip  right 
)
static

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

Parameters
leftThe left Pickup.
rightThe right Pickup.
Returns
true if left is not the same blip as right ; otherwise, false.

◆ operator==()

static bool GTA.Blip.operator== ( Blip  left,
Blip  right 
)
static

Determines if two Blips refer to the same blip.

Parameters
leftThe left Pickup.
rightThe right Pickup.
Returns
true if left is the same blip as right ; otherwise, false.

◆ RemoveNumberLabel()

void GTA.Blip.RemoveNumberLabel ( )

Removes the number label from this Blip.

Property Documentation

◆ Alpha

int GTA.Blip.Alpha
getset

Gets or sets the alpha of this Blip on the map.

◆ Color

BlipColor GTA.Blip.Color
getset

Gets or sets the color of this Blip.

◆ Entity

Entity GTA.Blip.Entity
get

Gets the Entity this Blip is attached to.

◆ IsFlashing

bool GTA.Blip.IsFlashing
getset

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

true if this Blip is flashing; otherwise, false.

◆ IsFriendly

bool GTA.Blip.IsFriendly
set

Sets a value indicating whether this Blip is friendly.

true if this Blip is friendly; otherwise, false.

◆ IsOnMinimap

bool GTA.Blip.IsOnMinimap
get

Gets a value indicating whether this Blip is on minimap.

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

◆ IsShortRange

bool GTA.Blip.IsShortRange
getset

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

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

◆ Name

string GTA.Blip.Name
set

Sets this Blips label to the given string.

◆ NumberLabel

int GTA.Blip.NumberLabel
set

Sets this Blips label to the given number.

◆ Position

Vector3 GTA.Blip.Position
getset

Gets or sets the position of this Blip.

◆ Priority

int GTA.Blip.Priority
set

Sets the priority of this Blip.

◆ Rotation

int GTA.Blip.Rotation
set

Sets the rotation of this Blip on the map.

◆ Scale

float GTA.Blip.Scale
set

Sets the scale of this Blip on the map.

◆ ShowRoute

bool GTA.Blip.ShowRoute
set

Sets a value indicating whether the route to this Blip should be shown on the map.

true to show the route; otherwise, false.

◆ Sprite

BlipSprite GTA.Blip.Sprite
getset

Gets or sets the sprite of this Blip.

◆ Type

int GTA.Blip.Type
get

Gets the type of this Blip.


The documentation for this class was generated from the following file: