🧭 Ui

File Path: modules/systems/c.ui.lua

Ensure that if custom functionality is utilized, it returns true.

Some script may override this position, in that case, you will have a config in a script which will override this value

Notification

Ui Position

top-left top-right bottom-left bottom-right top-center bottom-center

Lua

CustomUi.NotifyPosition = "top-right"

Notification Types

Lua

CustomUi.NotifyTypes = {
    ['info'] = "info",
    ['error'] = "error",
    ['success'] = "success",
    ['warning'] = "warning"
}

Custom Notification

text The text of the notification.
duration The duration for which the notification should be displayed. In milliseconds.
notificationType The type of the notification. 'info' 'error' 'success' 'warning'

Lua

CustomUi.Notify = function(text, duration, notificationType)
    return false -- if you are using a custom notification, return true
end

Static Message

Ui Position

top-left top-right bottom-left bottom-right {right = 0, top = 0}

Lua

CustomUi.StaticMessagePosition = "top-left"

Custom Static Message

text The text of the static message, if false ui is hidden.

Lua

CustomUi.ShowStaticMessage = function(text)
    return false -- if you are using a custom static message, return true
end

Control Buttons

Ui Position

top-left top-right bottom-left bottom-right {right = 0, top = 0}

Lua

CustomUi.ControlButtonsPosition= "bottom-right"

Custom Control Buttons

Displays control buttons to the user.

text The text associated with the control buttons, if false ui is hidden.

Lua

CustomUi.ShowControlButtons = function(text)
    return false -- if you are using a custom control buttons system, return true
end

Progressbar

Ui Position

low medium high

Lua

CustomUi.ProgressbarPlacement = "low"

Custom Progressbar

data The data for the progress bar.

data.duration The duration for which the progress bar should be displayed. In milliseconds.

data.text The text associated with the progress bar.

data.canStop A boolean indicating whether the progress bar can be stopped by the user.

data.placement The placement of the progress bar. Default low. [low, medium, high]

cb The callback function to be executed when the progress bar completes.

Lua

CustomUi.ShowProgressbar = function(data, cb)
    return false -- if you are using a custom progress bar, return true
end

Close Progressbar

Closes the progress bar

Lua

CustomUi.CloseProgressbar = function()
    return false -- if you are using a custom progress bar, return true
end