Prompt Module

The Prompt module provides a simple way to create and manage RedM prompts/hints that appear on screen.

Getting Started

local Prompt = exports.bln_lib:prompt()

Basic Usage

Create a Prompt

-- Simple prompt
Prompt.create(
    "myGroup",      -- Group name
    "Press [E]",    -- Display text
    "INPUT_PICKUP"  -- Control key
)

-- Hold prompt
Prompt.create(
    "myGroup",      -- Group name
    "Hold [E]",     -- Display text
    "INPUT_PICKUP", -- Control key
    2000           -- Hold time in ms
)

-- Multiple keys prompt
Prompt.create(
    "myGroup",                               -- Group name
    "Press [E] or [ENTER]",                 -- Display text
    {"INPUT_PICKUP", "INPUT_FRONTEND_ACCEPT"} -- Multiple keys
)

Display Prompts

-- Show prompt group with title
Prompt.displayGroup("myGroup", "Interact")

Check Prompt State

-- Check if completed
if Prompt.isCompleted("myGroup", "INPUT_PICKUP") then
    -- Do something
end

-- Check completion with continuous firing
if Prompt.isCompleted("myGroup", "INPUT_PICKUP", true) then
    -- Do something repeatedly while held
end

Methods

Prompt Creation

-- Create new prompt
Prompt.create(group, text, key, holdTime, page)

Prompt Management

-- Delete single prompt
Prompt.delete(group, key)

-- Delete group
Prompt.deleteGroup(group)

-- Delete all groups
Prompt.deleteAllGroups()

-- Edit prompt text
Prompt.editKeyLabel(group, key, newLabel)

Prompt Control

-- Enable/Disable prompt
Prompt.setEnabled(group, key, true/false)

-- Show/Hide prompt
Prompt.setVisible(group, key, true/false)

State Checks

-- Check if active
Prompt.isActive(group, key)

-- Check if enabled
Prompt.isEnabled(group, key)

-- Get hold progress (0.0 - 1.0)
Prompt.getProgress(group, key)

-- Check if key is pressed
Prompt.isPressed(key)

Examples

Simple Interaction

-- Create interaction prompt
Prompt.create("interact", "Press [E] to Search", "INPUT_PICKUP")

-- Display in game loop
Citizen.CreateThread(function()
    while true do
        Wait(0)
        Prompt.displayGroup("interact", "Search Box")
        
        if Prompt.isCompleted("interact", "INPUT_PICKUP") then
            -- Handle interaction
            print("Searching box...")
        end
    end
end)

Hold Action

-- Create hold prompt
Prompt.create("craft", "Hold [E] to Craft", "INPUT_PICKUP", 2000)

-- Display and check
Citizen.CreateThread(function()
    while true do
        Wait(0)
        Prompt.displayGroup("craft", "Crafting")
        
        if Prompt.isCompleted("craft", "INPUT_PICKUP") then
            -- Crafting completed
            print("Item crafted!")
        end
    end
end)

Multiple Actions

-- Create multiple prompts in same group
Prompt.create("menu", "Press [E] to Buy", "INPUT_PICKUP")
Prompt.create("menu", "Press [R] to Sell", "INPUT_RELOAD")

-- Display both
Citizen.CreateThread(function()
    while true do
        Wait(0)
        Prompt.displayGroup("menu", "Store")
        
        if Prompt.isCompleted("menu", "INPUT_PICKUP") then
            print("Buying...")
        elseif Prompt.isCompleted("menu", "INPUT_RELOAD") then
            print("Selling...")
        end
    end
end)

Target Entity Prompt

local promptGroupId = Citizen.InvokeNative(0xB796970BD125FCE8, targetEntity) -- PromptGetGroupIdForTargetEntity