BIS fnc showNotification: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Text replacement - "<code> *([^<|{]*) *<\/code>" to "<sqf>$1</sqf>")
(41 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma3
____________________________________________________________________________________________
|version1= 0.50


| arma3 |= Game name
|gr1= GUI


|1.00|= Game version
|eff= local
____________________________________________________________________________________________


| <pre>/*
|descr= Show a config-defined [[Arma 3: Notification|notification]].


Description:
|s1= [template, arguments] call [[BIS_fnc_showNotification]]
Shake mission notification.
When one is already shown, queue the new request and display it afterwards.
Uses templates defined in CfgNotifications.


Parameter(s):
|p1= '''template''': [[String]] - notification class name from {{hl|CfgNotifications}}
_this select 0 (Optional): STRING - template from CfgNotifications
_this select 1 (Optional): ARRAY - arguments passed to the template


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


//--- Don't show the notification on the misison start
|r1= [[Boolean]]
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_showNotification]]; --> |= Syntax
|x1= <sqf>["TaskSucceeded", ["", "Disable the nuke"]] call BIS_fnc_showNotification;</sqf>


|p1= |= Parameter 1
|x2= <sqf>["ScoreAdded", ["Disabled the nuke without triggering an alarm.", 5]] call BIS_fnc_showNotification;</sqf>
 
| |= Return value
____________________________________________________________________________________________
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| |= See also


|seealso= [[Arma 3: Notification]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: GUI|{{uc:showNotification}}]]
[[Category:Functions|{{uc:showNotification}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:showNotification}}]]

Revision as of 23:44, 12 July 2022

Arma 3 logo black.png0.50
LELocal
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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_showNotification&oldid=327064"