a library to speed up the development of Fivem scripts and frameworks
fivem-ts - Documentation v0.7.5 • Docs
fivem-ts - Documentation v0.7.5 / Client / Blip
Represents a map blip in the game environment.
new Blip(
handle):Blip
• handle: number
getAlpha():number
setAlpha(alpha):void
• alpha: number
number
getColor():BlipColors
setColor(color):void
• color: BlipColors
getDisplay():number
setDisplay(display):void
• display: number
number
getHandle():number
number
setIsCrew(crew):void
• crew: boolean
getIsFlashing():boolean
setIsFlashing(flashing):void
• flashing: boolean
boolean
setIsFriend(friend):void
• friend: boolean
setIsFriendly(friendly):void
• friendly: boolean
getIsOnMinimap():boolean
boolean
getIsShortRange():boolean
setIsShortRange(shortRange):void
• shortRange: boolean
boolean
setName(name):void
• name: string
setNumberLabel(number):void
• number: number
getPosition():Vector3
setPosition(vector):void
• vector: Vector3
setPriority(priority):void
• priority: number
getRotation():number
setRotation(rot):void
• rot: number
number
setScale(scale):void
• scale: BlipScale
setShowHeadingIndicator(show):void
• show: boolean
setShowRoute(show):void
• show: boolean
getSprite():BlipSprites
setSprite(sprite):void
• sprite: BlipSprites
getType():BlipType
delete():
void
Deletes the current blip if it exists. This method checks for the existence of the blip and removes it.
void
No return value.
exists():
boolean
Checks if the blip exists based on the current handle.
boolean
True if the blip exists, otherwise false.
removeNumberLabel():
void
Removes the numerical label displayed on the associated map blip.
void
staticcreateBlipFromArea(coords,width,height,name,sprite,display,scale,color,shortRange):BlipData
Creates a blip on the map from a specified area.
• coords: Vector3
The coordinate location for the blip.
• width: number
The width of the area for the blip.
• height: number
The height of the area for the blip.
• name: string
The name of the blip.
• sprite: BlipSprites
The sprite identifier for the blip.
• display: BlipDisplay
The display settings for the blip.
• scale: BlipScale
The scale of the blip.
• color: BlipColors
The color of the blip.
• shortRange: boolean
Indicates if the blip should only be visible on short range.
The data of the created blip.
staticcreateBlipFromCoords(coords,name,sprite,display,scale,color,shortRange):BlipData
Creates a blip on the map from the provided coordinates.
• coords: Vector3
The 3D coordinates where the blip will be created.
• name: string
The name of the blip.
• sprite: BlipSprites
The sprite type for the blip.
• display: BlipDisplay
The display setting for the blip.
• scale: BlipScale
The scale of the blip.
• color: BlipColors
The color of the blip.
• shortRange: boolean
Indicates if the blip is short-range (visible only when nearby).
The data structure representing the created blip.
staticcreateBlipFromRadius(coords,radius,name,sprite,display,scale,color,shortRange):BlipData
Creates a blip on the map using a specified radius and sets its data.
• coords: Vector3
The coordinates where the blip will be created.
• radius: number
The radius of the blip.
• name: string
The name of the blip for identification.
• sprite: BlipSprites
The sprite type of the blip to be displayed.
• display: BlipDisplay
The display style of the blip.
• scale: BlipScale
The scale of the blip on the map.
• color: BlipColors
The color of the blip.
• shortRange: boolean
Whether the blip is visible only when in short range.
The data of the created blip.