CreateTrayNotification: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Added examples and a note)
(Change parameter name)
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Client function}}
{{Client function}}
This functions creates a notification ballon on the desktop.
This functions creates a notification ballon on the desktop.


Line 8: Line 7:


==Syntax==
==Syntax==
<syntaxhighlight lang="lua">bool createTrayNotification ( string notificationText, [ string eType = "default", bool useSound = true ] )</syntaxhighlight>
<syntaxhighlight lang="lua">bool createTrayNotification ( string notificationText, [ string iconType = "default", bool useSound = true ] )</syntaxhighlight>


===Required Arguments===
===Required Arguments===
Line 14: Line 13:


===Optional Arguments===
===Optional Arguments===
*'''eType:''' The notification icon. Possible values are: '''"default", "info", "warning", "error"'''
*'''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.
*'''useSound:''' A boolean value indicating whether or not to play a sound when receiving the notification.


Revision as of 18:33, 20 October 2016

This functions creates a notification ballon 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 ingame. 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 ] )

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 )

See Also


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