Skip to content

utils.ui.showHelpNotification

utils.ui.showHelpNotification(msg, thisFrame, beep, duration)
This function shows a help notification with a message.

Arguments

Argument Data Type Optional Default Value Explanation
msg string No - The message to display
thisFrame boolean Yes false Only show this frame? Should be used with scripts that show notifications in a loop
beep boolean Yes true Play the beep sound?
duration number Yes -1 (5000 ms) Duration to show the help notification in milliseconds

Note

These help notification support displaying button inputs here.

Dependency

local utils = M("utils")

Example

utils.ui.showHelpNotification('A simple message ~INPUT_VEH_DROP_PROJECTILE~ ~INPUT_VEH_FLY_YAW_RIGHT~ ', false, true, 3000)

Improve this documentation