CreateTrayNotification

From Multi Theft Auto: Wiki
Revision as of 01:10, 30 December 2022 by FeaturedPro (talk | contribs) (made the GIF actually play 💀)
Jump to navigation Jump to search

This function creates a notification balloon on the desktop.

[[{{{image}}}|link=|]] Note: MTA won't show any tray notifications if the MTA window is focused, because there is no reason to show tray notifications if you are in-game. If you want to test this function you should use a Timer and switch to your desktop.
[[{{{image}}}|link=|]] Note: You can only show a tray notification every 30 seconds.

Syntax

bool createTrayNotification ( string notificationText [, string iconType = "default", bool useSound = true ] )
GIF preview of a tray notification
Tray Notification GIF

Required Arguments

  • notificationText: The text to send in the notification.

Optional Arguments

  • iconType: The notification icon type. Possible values are: "default" (the MTA icon), "info", "warning", "error"
  • useSound: A boolean value indicating whether or not to play a sound when receiving the notification.

Returns

Returns true if the notification is correctly created, false otherwise.

Example

-- Note: You have to wait 30 seconds before showing another tray notification, there is no queuing

-- Show a 'Hello World' notification
createTrayNotification( "Hello World" )

-- Show a notification with a warning symbol
createTrayNotification( "Hello World", "warning" )

-- Show a default notification without sound
createTrayNotification( "Hello World", "default", false )

Example of notification on minimize MTA application

function setTrayOnMinimize( )
     createTrayNotification( "We are waiting for you again...", "warning" )
end
addEventHandler( "onClientMinimize", root, setTrayOnMinimize )

Changelog

Version Description
1.5.6-9.16925 Added support for Windows 10

See Also



Retrieved from "https://wiki.multitheftauto.com/wiki/CreateTrayNotification?oldid=75891"