BIS fnc showNotification: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|= |p2=" to "|Parameter1= |p2=")
m (Link to CfgNotifications)
 
(30 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|Comments=
{{RV|type=function
____________________________________________________________________________________________


| arma3 |Game name=
|game1= arma3
|version1= 0.50


|0.50|Game version=
|gr1= GUI


|eff= local |=
|eff= local
____________________________________________________________________________________________


| Show [[Notification]]. |DESCRIPTION=
|descr= Show a config-defined [[Arma 3: Notification|notification]].
____________________________________________________________________________________________


| [template,(arguments)] call [[BIS_fnc_showNotification]]; |SYNTAX=
|s1= [template, arguments] call [[BIS_fnc_showNotification]]


|p1= '''template''': [[String]] - notification template from ''CfgNotifications'' |Parameter1=
|p1= '''template''': [[String]] - notification class name from [[Arma 3: Notification|CfgNotifications]]
|p2= '''arguments''': [[Array]] - additional arguments passed to the template (default: []) |=


| [[Boolean]] |RETURNVALUE=
|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}})
____________________________________________________________________________________________
 
|x1= <code>["TaskSucceeded",["","Disable the nuke"]] [[call]] [[BIS_fnc_showNotification]];</code> |=


|x2= <code>["ScoreAdded",["Disabled the nuke without triggering an alarm.",5]] [[call]] [[BIS_fnc_showNotification]];</code> |=
|r1= [[Boolean]]
____________________________________________________________________________________________


| [[Notification]] |SEEALSO=
|x1= <sqf>["TaskSucceeded", ["", "Disable the nuke"]] call BIS_fnc_showNotification;</sqf>


|x2= <sqf>["ScoreAdded", ["Disabled the nuke without triggering an alarm.", 5]] call BIS_fnc_showNotification;</sqf>
|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}}]]

Latest revision as of 16:55, 26 December 2023

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=351692"