Commands and Exports | Quasar Store

Commands and Exports | Quasar Store

Client Exports#

This section provides all available client exports for the script. These functions allow you to interact directly with the system from the client side, enabling custom features, UI interactions, and integrations with other resources. Each export includes a short description and usage example for easy implementation.

ToggleHud

The ToggleHud export from qs-interface allows you to toggle the visibility of the HUD (Heads-Up Display) for a player. This can be useful for hiding or showing interface elements depending on the situation or context in the game.

lua

local hudVisible = true -- Set to true to show, false to hide
exports['qs-interface']:ToggleHud(hudVisible)

In this example, setting to true will display the HUD, while setting it to false will hide it. You can change the value dynamically depending on the context or player actions. This export allows you to control when the HUD is visible or not, giving you flexibility in managing the player's interface experience in your scripts.

AddNotify

The AddNotify export from qs-interface allows you to display notifications to the player in the game. These notifications can have various types, and you can customize the message, title, duration, and icon that appears with it.

The basic syntax for the AddNotify export is as follows:

lua

exports['qs-interface']:AddNotify(message, title, duration, icon)

Example

lua

exports['qs-interface']:AddNotify('Message', 'Title', 2500, 'fa-solid fa-file')

IsInYachtInterior

The ProgressBar export from qs-interface provides an easy way to display a progress bar during in-game actions, such as crafting, loading, or any other time-consuming tasks. It gives players visual feedback on the progress of an action and can be customized to fit your needs.

In this tutorial, we will explain how to use the ProgressBar export, with an example of integrating it into a custom command.

To use the ProgressBar export, follow these simple steps:

lua

local success = exports['qs-interface']:ProgressBar({
    duration = duration,         -- Duration of the progress bar (in milliseconds)
    label = label,               -- Text that will appear on the progress bar
    position = 'bottom',         -- Position of the progress bar on the screen (e.g., 'top', 'bottom', 'center')
    useWhileDead = useWhileDead, -- Whether the progress bar shows when the player is dead (true/false)
    canCancel = canCancel,       -- Whether the player can cancel the progress (true/false)
    disable = disableControls,   -- Whether to disable player controls during the progress (true/false)
    anim = {                     -- Animation to be played while the progress is happening
        dict = animation.animDict,
        clip = animation.anim,
        flag = animation?.flags   -- Optional animation flags
    },
    prop = prop                  -- Optional prop to show alongside the progress bar (can be nil)
})

Example: Using ProgressBar in a Command

Let’s integrate the ProgressBar export into a simple command. For this example, we’ll use a 5-second progress bar to simulate crafting.

lua

RegisterCommand('startAction', function()
    local success = exports['qs-interface']:ProgressBar({
        duration = 5000,
        label = "Crafting...",
        position = 'bottom',
        canCancel = true
    })

    if success then
        print("Action completed!")
    else
        print("Action canceled!")
    end
end, false)

interface:notification

The interface:notification event allows you to send styled notifications to a specific player client-side. This is especially useful for displaying alerts, messages, or system feedback in a consistent and customizable way across your server.

lua

TriggerClientEvent('interface:notification', source, text, header, duration, icon)

Example

Here’s a working example using a simple test command:

lua

RegisterCommand("quasar_notify", function(source, args, rawCommand)
    TriggerClientEvent('interface:notification', source, "This is a test notification.", "Quasar Alert", 5000, "fas fa-file")
end, false)

Running /quasar_notify in-game will display a sample notification to the player who executes it.