FiveM Documentation
Documentation
Forum
Discord
Servers
GitHub
Terms of Service
Documentation
Client manual
Where to buy GTA V
System requirements
Installing FiveM
Console commands
Crosshair commands
Server manual
Setting up a server
Setting up a server using ZAP-Hosting
Setting up a server using txAdmin
Setting up a Vanilla FXServer
Server Commands
Proxy Setup
Migrating from CitizenMP.Server
Finding resources
Frameworks
Guides for scripting
Scripting introduction
Introduction to resources
Creating your first script in C#
Creating your first script in JavaScript
Creating your first script in Lua
About native functions
Fact Sheet
Scripting runtimes
Scripting in Lua
Scripting in JavaScript
Scripting in C#
Networking
Network and local IDs
State bags
Migrating from deprecated methods
Creating chat messages
Creating commands
Working with events
Listening for events
Triggering events
User interfaces with NUI
Fullscreen NUI
Direct-rendered UI
NUI callbacks
Loading screens
Voice
Using Scaleform
Debugging
Using the profiler
Scripting reference
Client functions
Server functions
Resource manifest
Runtime-specific references
C# function reference
Client-side functions in C#
Server-side functions in C#
JavaScript function reference
Client-side functions in JavaScript
Server-side functions in JavaScript
Lua function reference
Client-side functions in Lua
Server-side functions in Lua
Events
Client events
Server events
List of events
gameEventTriggered
onClientResourceStart
onClientResourceStop
onResourceStart
onResourceStarting
onResourceStop
playerConnecting
playerDropped
respawnPlayerPedEvent
vehicleComponentControlEvent
populationPedCreating
rconCommand
Convars
OneSync
Stock resources
baseevents
chat
Events
chat:addMessage
chat:addSuggestion
chat:addSuggestions
chat:addTemplate
chat:clear
chat:removeSuggestion
chatMessage
Exports
addMessage (client)
addMessage (server)
addSuggestion
registerMessageHook
registerMode
mapmanager
sessionmanager
spawnmanager
txAdmin
Game references
Controls
Input mapper/parameter IDs
DIGITALBUTTON_AXIS
GAME_CONTROLLED
JOYSTICK_AXIS
JOYSTICK_AXIS_NEGATIVE
JOYSTICK_AXIS_POSITIVE
JOYSTICK_BUTTON
JOYSTICK_IAXIS
JOYSTICK_POV
JOYSTICK_POV_AXIS
KEYBOARD
MKB_AXIS
MOUSE_ABSOLUTEAXIS
MOUSE_BUTTON
MOUSE_BUTTONANY
MOUSE_CENTEREDAXIS
MOUSE_NORMALIZED
MOUSE_RELATIVEAXIS
MOUSE_SCALEDAXIS
MOUSE_WHEEL
PAD_ANALOGBUTTON
PAD_AXIS
PAD_DEBUGBUTTON
PAD_DIGITALBUTTON
PAD_DIGITALBUTTONANY
TOUCHPAD_ABSOLUTE_AXIS
TOUCHPAD_CENTERED_AXIS
Blips
Checkpoints
Markers
Data files
Game events
Gamer tags
Ped models
Vehicle models
HUD colors
Profile Settings
Text formatting
Support
Client FAQ
Client issues
Server debugging
Server issues
Bans FAQ
Resource FAQ
Developer docs
Script runtimes
FxDK
Resources
World Editor
Project building
FXCode
Contributing
Git
Squash Guide
Rebase Guide
How you can help
Edit this page
Create documentation issue
Create project issue
Documentation
Scripting reference
Runtime-specific references
Lua function reference
List of functions in Lua
Citizen.Await
Citizen.Await
Syntax
Citizen.Await
(
awaitable
)
Last modified December 18, 2019:
Move {root->content} again for edit links. (483165c)