DisplayOnscreenKeyboard - FiveM Natives @ Cfx.re Docs

FiveM Docs / Native Reference

Namespace: MISCAPI set: clientGame: gta5editImprove

DISPLAY_ONSCREEN_KEYBOARD

0x00DC833F2568DBF6

0xAD99F2CE

// DisplayOnscreenKeyboard
void DISPLAY_ONSCREEN_KEYBOARD(int keyboardType, char* windowTitle, char* description, char* defaultText, char* defaultConcat1, char* defaultConcat2, char* defaultConcat3, int maxInputLength);

Parameters:

keyboardType:
See the list above. Default is 0.
windowTitle:
Text label for the title of the box.
description:
Has no use on PC.
defaultText:
Default text that is written in the input field.
defaultConcat1:
defaultConcat2:
defaultConcat3:
maxInputLength:
Max number of characters that can be typed (2 - 256).

Displays a text input box.

enum eKeyboardType
{
  ONSCREEN_KEYBOARD_ENGLISH = 0,
  ONSCREEN_KEYBOARD_LOCALISED = 1,
  ONSCREEN_KEYBOARD_PASSWORD = 2,
  ONSCREEN_KEYBOARD_GAMERTAG = 3,
  ONSCREEN_KEYBOARD_EMAIL = 4,
  ONSCREEN_KEYBOARD_BASIC_ENGLISH = 5,
  ONSCREEN_KEYBOARD_FILENAME = 6
};

Examples:

Lua

AddTextEntry("my_input_title", "Enter something cool:")

DisplayOnscreenKeyboard(0, "my_input_title", "", "", "", "", "", 30) -- Show the text input box

while UpdateOnscreenKeyboard() == 0 do Wait(0) end -- Wait for the user to stop editing

-- This block of code is reached after the user is done editing

local inputUpdate = UpdateOnscreenKeyboard()

if inputUpdate == 1 then -- User hit OK in the text input box
  local result = GetOnscreenKeyboardResult()
  print("You wrote this in the input box:", result)
elseif inputUpdate == 2 then
  print("You canceled the input!")
else -- -1 or 3
  print("An error has occurred")
end

CLEAR_AREA(float X, float Y, float Z, float radius, BOOL p4, BOOL ignoreCopCars, BOOL ignoreObjects, BOOL p7)

CLEAR_AREA_LEAVE_VEHICLE_HEALTH(float x, float y, float z, float radius, BOOL p4, BOOL p5, BOOL p6, BOOL p7)

CLEAR_AREA_OF_COPS(float x, float y, float z, float radius, BOOL createNetEvent)

CLEAR_AREA_OF_OBJECTS(float x, float y, float z, float radius, int flags)

CLEAR_AREA_OF_PEDS(float x, float y, float z, float radius, BOOL createNetEvent)

CLEAR_AREA_OF_PROJECTILES(float x, float y, float z, float radius, BOOL createNetEvent)

CLEAR_AREA_OF_VEHICLES(float x, float y, float z, float radius, BOOL p4, BOOL p5, BOOL p6, BOOL p7, BOOL p8)

CLEAR_BIT(int* address, int offset)

_CLEAR_CLOUD_HAT

CLEAR_OVERRIDE_WEATHER

CLEAR_REPLAY_STATS

_CLEAR_RESTART_CUSTOM_POSITION

_CLEAR_TACTICAL_ANALYSIS_POINTS

CLEAR_WEATHER_TYPE_NOW_PERSIST_NETWORK(int transitionTimeInMs)

CLEAR_WEATHER_TYPE_PERSIST

COMPARE_STRINGS(char* str1, char* str2, BOOL matchCase, int maxLength)

_COPY_MEMORY(Any* dst, Any src, int size)

CREATE_INCIDENT(int dispatchService, float x, float y, float z, int numUnits, float radius, int* outIncidentID)

CREATE_INCIDENT_WITH_ENTITY(int dispatchService, Ped ped, int numUnits, float radius, int* outIncidentID)

DELETE_INCIDENT(int incidentId)

DELETE_STUNT_JUMP(int p0)

DISABLE_HOSPITAL_RESTART(int hospitalIndex, BOOL toggle)

DISABLE_POLICE_RESTART(int policeIndex, BOOL toggle)

DISABLE_STUNT_JUMP_SET(int p0)

DISPLAY_ONSCREEN_KEYBOARD(int keyboardType, char* windowTitle, char* description, char* defaultText, char* defaultConcat1, char* defaultConcat2, char* defaultConcat3, int maxInputLength)

DISPLAY_ONSCREEN_KEYBOARD_WITH_LONGER_INITIAL_STRING(int keyboardType, char* windowTitle, char* description, char* defaultText, char* defaultConcat1, char* defaultConcat2, char* defaultConcat3, char* defaultConcat4, char* defaultConcat5, char* defaultConcat6, char* defaultConcat7, int maxInputLength)

DOES_POP_MULTIPLIER_AREA_EXIST(int id)

DOES_POP_MULTIPLIER_SPHERE_EXIST(int id)

ENABLE_DISPATCH_SERVICE(int dispatchService, BOOL toggle)

ENABLE_STUNT_JUMP_SET(int p0)

ENABLE_TENNIS_MODE(Ped ped, BOOL toggle, BOOL p2)

END_REPLAY_STATS

FIND_SPAWN_POINT_IN_DIRECTION(float posX, float posY, float posZ, float dirX, float dirY, float dirZ, float distance, Vector3* spawnPoint)

FORCE_GAME_STATE_PLAYING