Skip to content

Commit

Permalink
tweak(natives/hud): add description and example for SET_BLIP_COLOUR (#…
Browse files Browse the repository at this point in the history
…1166)

* tweak(natives/hud): add description and example for SET_BLIP_COLOUR

* tweak(natives/hud): move description to match guidelines example

* Put description under parameter

---------

Co-authored-by: Dillon Skaggs <[email protected]>
  • Loading branch information
MadsLeander and AvarianKnight authored Aug 23, 2024
1 parent 54a0002 commit 830e31d
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions HUD/SetBlipColour.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,16 @@ void SET_BLIP_COLOUR(Blip blip, int color);
```
## Parameters
* **blip**:
* **color**: See [blip colors here](https://docs.fivem.net/docs/game-references/blips/#blip-colors)
* **blip**: The blip handle to set the color of
* **color**: This can be a hex color code, or a [blip color](https://docs.fivem.net/docs/game-references/blips/#blip-colors).
## Examples
```lua
local coords = GetEntityCoords(PlayerPedId())
local blip = AddBlipForCoord(coords.x, coords.y, coords.z)
SetBlipColour(blip, 1) -- Sets the color to red (see list above)
-- You can also use a hex like so:
SetBlipColour(blip, 0x3A7F3AFF) -- Our custom green
```

0 comments on commit 830e31d

Please sign in to comment.