Dev Tools
FiveM Lib
Lua
Visual

Visual

AddLongString

Is used with ShowHelpLongString to increase the string length.

Visual.AddLongString(text)
  • text: string

BottomText

Adds a basic GTA bottom print.

Visual.BottomText(text, time)
  • text: string
  • time: number

example:

while true do
    Wait(0)
    Visual.BottomText('This is a bottom text')
end

resmon: ~0.05ms

Draw3DText

Renders 3d text.

Visual.Draw3DText(text, coords)
  • text: string
  • coords: table | vec3

This function has to be called every tick.

example

while true do
    Wait(0)
    Visual.Draw3DText('This is a 3D Text', vec3(323.3, 13.45, 56.76))
end

DrawProgressBar

Draws a new progress bar.

Visual.DrawProgressBar(x, y, width, height, r, g, b, a)
  • x: number
  • y: number
  • width: number
  • height: number
  • r: number
  • g: number
  • b: number
  • a: number

example:

TODO

DynamicScreen

Is used to properly set the screen x coordinates of an native element based on the active screen resolution.

Visual.DynamicScreen(offsetX)
  • offsetX: number

example:

TODO

IconNotify

Displays GTA notification with an icon.

Visual.IconNotify(textureDict, textureName, title, subtitle, text)
  • textureDict: string
  • textureName: string
  • title: string
  • subtitle: string
  • text: string

example:

TODO

InputBox

Basic GTA input field.

Visual.InputBox(displayText, bitLenght)
  • displayText: string
  • bitLenght: number

example:

TODO

MugNotify

Displays GTA notification with a mugshot of the player.

Visual.MugNotify(message, gainedRP, color)
  • message: string
  • gainedRP: number
  • color: number

example:

TODO

Notify

Simple GTA notification without any fancy stuff. Just text.

Visual.Notify(text)
  • text: string

example:

Visual.Notify('This is a new notification!')

RenderSprite

Renders new sprite.

Visual.RenderSprite(txdDict, txdName, x, y, width, height, heading, r, g, b, a)
  • txdDict: string
  • txdName: string
  • x: number
  • y: number
  • width: number
  • height: number
  • heading: number
  • r: number
  • g: number
  • b: number
  • a: number

example:

TODO

ShowHelp

Adds a basic GTA help notification in the top left side of screen.

Visual.ShowHelp(text, bleep)
  • text: string
  • bleep: boolean

example:

Visual.ShowHelp('This is a help notification, press ~INPUT_CONTEXT~ to accept TOS!', true)

ShowHelpLongString

Adds a basic GTA help notification in the top left side of screen. Can display an infinite string length.

Visual.ShowHelp(text, bleep)
  • text: string
  • bleep: boolean

example:

Visual.ShowHelpLongString('This is a very, very, very, veeeeeeerryyyyy long help notification, press ~INPUT_CONTEXT~ to accept TOS!', true)
TextComponents