BIS fnc 3DENNotification: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Text replacement - "since= Arma3" to "since= arma3")
 
(11 intermediate revisions by 3 users not shown)
Line 8: Line 8:
|gr1= Eden Editor
|gr1= Eden Editor


|descr= Shows notification banner with given text, animated or not, at the top of the screen in the [[Eden Editor]].
|descr= Shows notification banner with given text, animated or not, at the top of the screen in the [[:Category:Eden Editor|Eden Editor]].<br/>
 
Since {{GVI|arma3|2.10}} this function will no longer throw an error outside of [[:Category:Eden Editor|Eden Editor]]. Because {{hl|Display3DEN}} (<sqf inline>findDisplay 313</sqf>) is not available, it will only play the sound according to the message type.
|pr= This function needs ''Display3DEN'' ({{ic|[[findDisplay]] 313}}) to be active and visible in order to work. During scenario preview its effect will not be visible and during a scenario play-through it will throw an error.
The sound is played through the UI channel with [[playSoundUI]].


|s1= [text, type, duration, animate] call [[BIS_fnc_3DENNotification]]
|s1= [text, type, duration, animate] call [[BIS_fnc_3DENNotification]]


|p1= text: [[String]] - Either text or class from {{hl|Cfg3DEN >> Notifications}}
|p1= text: [[String]] or [[Structured Text]] - either text or class from <sqf inline>"Cfg3DEN" >> "Notifications"</sqf>


|p2= type: [[Number]] - (Optional, default 0) 0: Notification (Green) 1: Warning (Red)
|p2= type: [[Number]] - (Optional, default 0) 0: Notification (Green) 1: Warning (Red)


|p3= duration: [[Number]] - (Optional, default 2) Duration in seconds (+ 1 sec for each new line)
|p3= duration: [[Number]] - (Optional, default 2) duration in seconds (+ 1 sec for each new line)


|p4= animate: [[Boolean]] - (Optional, default [[true]]) Toggle animation
|p4= animate: [[Boolean]] - (Optional, default [[true]]) toggle animation


|p5= volume: [[Number]] - (Optional, default 1) volume adjustment
|p5= volume: [[Number]] - (Optional, default 1) volume adjustment
|p5since= Arma3 2.10
|p5since= arma3 2.10


|r1= [[Number]] - Selected Mode
|r1= [[Number]] - selected Mode


|x1= <sqf>["This is an animated notification", 0] call BIS_fnc_3DENNotification;</sqf>
|x1= <sqf>["This is an animated notification", 0] call BIS_fnc_3DENNotification;</sqf>
Line 31: Line 31:
|x2= <sqf>["This is a warning that is not animated", 1, 2, false] call BIS_fnc_3DENNotification;</sqf>
|x2= <sqf>["This is a warning that is not animated", 1, 2, false] call BIS_fnc_3DENNotification;</sqf>


|seealso= [[Eden Editor]] [[BIS_fnc_3DENShowMessage]]
|x3= <sqf>["For more information visit <t colorLink='#E69710'><a href='https://community.bistudio.com/wiki/BIS_fnc_3DENNotification'>Community Wiki</a></t>"] call BIS_fnc_3DENNotification;</sqf>
 
|seealso= [[:Category:Eden Editor|Eden Editor]] [[BIS_fnc_3DENShowMessage]]
}}
}}

Latest revision as of 16:26, 9 February 2024

Arma 3 logo black.png1.58
LELocal
Hover & click on the images for description

Description

Description:
Shows notification banner with given text, animated or not, at the top of the screen in the Eden Editor.
Since Arma 3 logo black.png2.10 this function will no longer throw an error outside of Eden Editor. Because Display3DEN (findDisplay 313) is not available, it will only play the sound according to the message type. The sound is played through the UI channel with playSoundUI.
Execution:
call
Groups:
Eden Editor

Syntax

Syntax:
[text, type, duration, animate] call BIS_fnc_3DENNotification
Parameters:
text: String or Structured Text - either text or class from "Cfg3DEN" >> "Notifications"
type: Number - (Optional, default 0) 0: Notification (Green) 1: Warning (Red)
duration: Number - (Optional, default 2) duration in seconds (+ 1 sec for each new line)
animate: Boolean - (Optional, default true) toggle animation
since Arma 3 logo black.png2.10
volume: Number - (Optional, default 1) volume adjustment
Return Value:
Number - selected Mode

Examples

Example 1:
["This is an animated notification", 0] call BIS_fnc_3DENNotification;
Example 2:
["This is a warning that is not animated", 1, 2, false] call BIS_fnc_3DENNotification;
Example 3:
["For more information visit <t colorLink='#E69710'><a href='https://community.bistudio.com/wiki/BIS_fnc_3DENNotification'>Community Wiki</a></t>"] call BIS_fnc_3DENNotification;

Additional Information

See also:
Eden Editor BIS_fnc_3DENShowMessage

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_3DENNotification&oldid=352420"