Start
Opening the phone
The open key and command, why the phone may refuse to open, and walking with the phone open.
#Keys and commands
| Key or command | Default | What it does |
|---|---|---|
/phone |
F1 | Opens or closes the phone. Name: Config.OpenCommand, key: Config.OpenKey |
+phone_look |
Left Alt (hold) | Releases the mouse to look around while the phone is open |
/phoneadmin |
None | Opens the admin tablet. Needs a role. Name: Config.Admin.Command |
/phonecam |
None | Opens the lens tuning panel. Needs the role in Config.Camera.TuneRole. Name: Config.Camera.TuneCommand |
+phone_<name> |
Set by the resource | Key binds added by other resources through AddKeyBind |
Keys are FiveM key mappings. Players change them in GTA Settings > Key Bindings > FiveM. OpenKey is only the default: changing it later does not move the key for players who already have the binding.
There are no answer or hang-up commands. Calls are handled in the phone and on the Dynamic Island.
Using the phone item from the inventory also opens the phone.
#When the phone does not open
| Reason | What the player sees |
|---|---|
| The character is not loaded yet | Nothing. Wait until the character has spawned |
| No phone item | A notice that a phone is needed |
| The character is dead | A notice. Dying also closes the phone and ends the call |
The phone was disabled by a script (ToggleDisabled) |
A notice |
| The battery is empty | A notice. See Battery |
Another resource refused it with AddCheck |
That resource's message, if it gives one |
Other scripts can open, close and check the phone: see Phone exports and Checks.
#Walking with the phone open
With Config.WalkWhileOpen = true (the default) the player can walk, run and drive while the phone is open. The movement keys stay with the game; the mouse works the phone.
While the phone is open some game controls are switched off so a click on the phone does not also fire in the game: looking around with the mouse, attacking and aiming, the weapon wheel and the pause menu. Esc closes the phone instead of opening the pause menu.
While the cursor is in a text field, every key goes to the phone, so W types a "w" instead of moving. Leaving the field gives the keys back.
Config.WalkWhileOpen = false keeps the character still while the phone is open.
#Looking around
Hold Left Alt to look around with the mouse while the phone stays open. Let go and the mouse returns to the phone.
- Only Left Alt. Right Alt (AltGr) is left alone, because it types characters such as
@on many keyboards. - The key binding is
+phone_look, shown under GTA Settings > Key Bindings > FiveM. Players can move it. - ox_target also listens on Left Alt. While the player looks around, ox_target is paused so its eye does not open.
- An app may need Alt for itself. While such an app is in front, Alt does not start looking around.
#Movement guard
Config.MovementGuard = true (the default) handles a known FiveM problem: when the keyboard changes hands between the game and the phone while a key is down, the game can miss the key coming up, and the character keeps running on its own.
The guard reads the real keyboard next to the game. When the game still thinks a direction is held but its key has been up for about 0.2 seconds, that direction is switched off until the key goes down again.
- It only acts while the phone is open, and only on the keyboard, never on a controller.
- It only judges a press once it has seen the key really go down. On a game client that does not report the raw keyboard, the guard never steps in.
- It follows the player's own movement keys, as long as they are bound to letters or digits.
Set it to false if it gets in the way.
#Face ID
Config.FaceId controls Face ID (Settings > Face ID & Passcode), which unlocks the phone without the passcode when its owner looks at it. It needs a passcode, and turning it on or off asks for that passcode. With MaskBlocks = true a mask on the face is not recognised and the passcode is asked instead. See config.lua.
#Related settings
All of the options on this page are in config.lua: config.lua.