# Blip Setup

## Properties

### Name

Key: `name`

The name of the blip on map. You can use placeholders to display informations about the player.

Placeholders:

* `{JOB_NAME}` - Job name
* `{GRADE_NAME}` - Grade name of job
* `{PLAYER_NAME}` - Player's character name
* `{PREFIX}` - Prefix set by player (/prefix)
* `{SUFFIX}` - Suffix set by player (/suffix)

### Sprite

Key: `sprite`

Appearance of the blip on map. All sprites are listed in [FiveM Docs](https://docs.fivem.net/docs/game-references/blips/#blips).

### Color

Key: `color`

Color of the blip on map. All colors are also listed in [FiveM Docs](https://docs.fivem.net/docs/game-references/blips/#blip-colors).

### Scale

Key: `scale`

Size of the blip on map. `1.0` is normal size.

### Display

Key: `display`

Where blip should be displayed.

Display IDs:

* `2` - Shows on both main map and minimap.
* `4` - Shows on main map only.
* `5` - Shows on minimap only.

### Short range

Key: `shortRange`

Whether blip should be show on minimap short range or not.

### Category

Key: `category`

In what category blip should be display on legend (right list of blips) of the big map We suggest to keep it on default `7`.

### Heading indicator

Key: `headingIndicator`

Show black arrow heading indicator on blips or not

![](https://1037498771-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MZErcztD5BvrKnwRGJq%2Fuploads%2Fgit-blob-79418d03104a562df44299d5fce29d7d658e9506%2Fjob_blips_headingIndicator.png?alt=media)

### Cone

Key: `showCone`

Show white cone on blip showing where player looks

![](https://1037498771-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MZErcztD5BvrKnwRGJq%2Fuploads%2Fgit-blob-48f70c4593041a2a6bf2c606f907a75bf15ac8fb%2Fjob_blips_showCone.png?alt=media)

### Siren flash

Key: `sirenFlash`

Changing color of the blip if player is sitting in emergency vehicle with sirens enabled. All colors are also listed in [FiveM Docs](https://docs.fivem.net/docs/game-references/blips/#blip-colors).

## Example

```lua
blip = {
    name = '[{JOB_NAME} - {GRADE_NAME}] - {PREFIX} {PLAYER_NAME} {SUFFIX}',
    sprite = 60,
    color = 8,
    headingIndicator = true,
    showCone = true,
    category = 7
},

vehicleBlip = {
    color = 3,
    sirenFlash = 1 
}
```
