SetFloatingHelpTextStyle - FiveM Natives @ Cfx.re Docs

FiveM Docs / Native Reference

Namespace: HUDAPI set: clientGame: gta5editImprove

SET_FLOATING_HELP_TEXT_STYLE

0x788E7FD431BD67F1

0x97852A82

// SetFloatingHelpTextStyle
void SET_FLOATING_HELP_TEXT_STYLE(int hudIndex, int style, int hudColor, int alpha, int arrowPosition, int boxOffset);

Parameters:

hudIndex:
The hud index for the floating help message
style:
Value 0 won't show an arrow at all. Values 1, 2 and -2 will display an arrow.
hudColor:
https://docs.fivem.net/docs/game-references/hud-colors/
alpha:
Value for the help box opacity, from 0-255. Anything greater will simply ignore the alpha value. Always 191 in R* scripts.
arrowPosition:
Used to set the arrow positon. No value will hide the arrow
boxOffset:
Offset for the floating help box. Note: Arrow stays fixed

Arrow Positions

0 = Off / No arrow
1 = Top
2 = Left
3 = Bottom
4 = Right

Note

Any numeric value greater than 4 will result in a right arrow (Index 4)

Important

Needs to be called every frame

Preview of the provided example code

Examples:

Lua
JavaScript

function DisplayHelpText(string)
    BeginTextCommandDisplayHelp("STRING")
    AddTextComponentSubstringPlayerName(string)
    EndTextCommandDisplayHelp(1, false, false, 0)
end

CreateThread(function()
    while true do
        Wait(0)

        local Ped = PlayerPedId()

        DisplayHelpText('Example Text')
        SetFloatingHelpTextStyle(0, 2, 2, 0, 3, 0)
        SetFloatingHelpTextToEntity(0, Ped, 0, 0)
    end
end)

SET_BLIP_FADE(Blip blip, int opacity, int duration)

SET_BLIP_FLASH_INTERVAL(Blip blip, int interval)

SET_BLIP_FLASH_TIMER(Blip blip, int duration)

SET_BLIP_FLASHES(Blip blip, BOOL toggle)

SET_BLIP_FLASHES_ALTERNATE(Blip blip, BOOL toggle)

SET_BLIP_HIDDEN_ON_LEGEND(Blip blip, BOOL toggle)

SET_BLIP_HIGH_DETAIL(Blip blip, BOOL toggle)

SET_BLIP_NAME_FROM_TEXT_FILE(Blip blip, char* gxtEntry)

SET_BLIP_NAME_TO_PLAYER_NAME(Blip blip, Player player)

SET_BLIP_PRIORITY(Blip blip, int priority)

SET_BLIP_ROTATION(Blip blip, int rotation)

SET_BLIP_ROUTE(Blip blip, BOOL enabled)

SET_BLIP_ROUTE_COLOUR(Blip blip, int colour)

SET_BLIP_SCALE(Blip blip, float scale)

_SET_BLIP_SCALE_TRANSFORMATION(Blip blip, float xScale, float yScale)

SET_BLIP_SECONDARY_COLOUR(Blip blip, int r, int g, int b)

SET_BLIP_SHOW_CONE(Blip blip, BOOL toggle)

_SET_BLIP_SHRINK(Blip blip, BOOL toggle)

SET_BLIP_SPRITE(Blip blip, int spriteId)

_SET_BLIP_SQUARED_ROTATION(Blip blip, float heading)

SET_COLOUR_OF_NEXT_TEXT_COMPONENT(int hudColor)

_SET_DIRECTOR_MODE_CLEAR_TRIGGERED_FLAG

SET_FAKE_PAUSEMAP_PLAYER_POSITION_THIS_FRAME(float x, float y)

SET_FLOATING_HELP_TEXT_SCREEN_POSITION(int hudIndex, float x, float y)

SET_FLOATING_HELP_TEXT_STYLE(int hudIndex, int style, int hudColor, int alpha, int arrowPosition, int boxOffset)

SET_FLOATING_HELP_TEXT_TO_ENTITY(int hudIndex, Entity entity, float offsetX, float offsetY)

SET_FLOATING_HELP_TEXT_WORLD_POSITION(int hudIndex, float x, float y, float z)

SET_FRONTEND_ACTIVE(BOOL active)

SET_GPS_CUSTOM_ROUTE_RENDER(BOOL toggle, int radarThickness, int mapThickness)

SET_GPS_FLAGS(int p0, float p1)

SET_GPS_FLASHES(BOOL toggle)

SET_GPS_MULTI_ROUTE_RENDER(BOOL toggle)

SET_HEALTH_HUD_DISPLAY_VALUES(int health, int capacity, BOOL wasAdded)

_SET_HELP_MESSAGE_TEXT_STYLE(int style, int hudColor, int alpha, int p3, int p4)

SET_HUD_COMPONENT_POSITION(int id, float x, float y)