Help Notification

Help Notifications are displayed in the top-left corner of the screen. They are specifically designed to manage job-related updates and other critical tasks.

Add

To add Help Notification, you can simply call the export:

exports['ZSX_UIV2']:HelpNotification(data)

Data object contains:

-- Example with text as an object (it creates thing like tasks-list)
local data = {
    icon = 'fas fa-warehouse',
    header = 'Task Example',
    text = {
        {
            name = 'point1', -- make sure to add name otherwise it won't be added!
            active = true, -- make sure to set one as an active element!
            complete = false,
            text = 'Go to Point #1',
        }, {
            name = 'point2',
            active = false,
            complete = false,
            text = 'Finish by going to Point #2',
        }
    }
}

-- Example with text as an string
local data = {
    icon = 'fas fa-warehouse',
    header = 'Task Example',
    text = 'Do anything else!'
}

Data layout

Key	Value	Optional
icon	String Icon of the help notification, list
header	String Header of the help notification.
text	String/Object Text/Object of the help notification.

Text as object layout

Key	Value	Optional
name	String Unique name of the task.
active	Boolean Mark stage as active (current).
complete	Boolean Mark stage as already done.
text	String Text of the stage

Manually updating stage

This mainly focuses on the text as an object, since you can't update the stage for non-task element.

exports['ZSX_UIV2']:HelpNotification_UpdateStage(data)

Data object contains:

-- Updating stage by switching element to active one
local data = {
    stage = 'point1',
    key = 'active',
    value = true
}

Key	Value
stage	String Unique name set for the stage.
key	String Key of the updated element.
value	Boolean Value of the updated element.

Marking stage as active

exports['ZSX_UIV2']:HelpNotification_SetStageAsActive(stageName)

Marking stage as complete

exports['ZSX_UIV2']:HelpNotification_SetStageAsComplete(stageName)

Remove

In order to remove Help Notification you can use that export:

exports['ZSX_UIV2']:HelpNotification_Remove()