BIS fnc showNotification: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "(Optional, default [])" to "(Optional, default {{hl|[]}})")
m (Link to CfgNotifications)
 
(One intermediate revision by one other user not shown)
Line 12: Line 12:
|s1= [template, arguments] call [[BIS_fnc_showNotification]]
|s1= [template, arguments] call [[BIS_fnc_showNotification]]


|p1= '''template''': [[String]] - notification class name from {{hl|CfgNotifications}}
|p1= '''template''': [[String]] - notification class name from [[Arma 3: Notification|CfgNotifications]]


|p2= '''arguments''': [[Array]] - (Optional, default {{hl|[]}}) additional [[format]] arguments to fill notification's fields ({{hl|title}}, {{hl|description}}, {{hl|iconPicture}}, {{hl|iconText}}, {{hl|soundRadio}})
|p2= '''arguments''': [[Array]] - (Optional, default <sqf inline>[]</sqf>) additional [[format]] arguments to fill notification's fields ({{hl|title}}, {{hl|description}}, {{hl|iconPicture}}, {{hl|iconText}}, {{hl|soundRadio}})


|r1= [[Boolean]]
|r1= [[Boolean]]

Latest revision as of 16:55, 26 December 2023

Hover & click on the images for description

Description

Description:
Show a config-defined notification.
Execution:
call
Groups:
GUI

Syntax

Syntax:
[template, arguments] call BIS_fnc_showNotification
Parameters:
template: String - notification class name from CfgNotifications
arguments: Array - (Optional, default []) additional format arguments to fill notification's fields (title, description, iconPicture, iconText, soundRadio)
Return Value:
Boolean

Examples

Example 1:
["TaskSucceeded", ["", "Disable the nuke"]] call BIS_fnc_showNotification;
Example 2:
["ScoreAdded", ["Disabled the nuke without triggering an alarm.", 5]] call BIS_fnc_showNotification;

Additional Information

See also:
Arma 3: Notification

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note