BIS fnc 3DENNotification: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Some wiki formatting)
Line 10: Line 10:
|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 [[Eden Editor]].


|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 (fixed in 2.10)
|pr= This function needs {{hl|Display3DEN}} (<sqf inline>findDisplay 313</sqf>) 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 (fixed in 2.10).


|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]] - 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)

Revision as of 16:23, 27 July 2022

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.
Execution:
call
Problems:
This function needs Display3DEN (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 (fixed in 2.10).
Groups:
Eden Editor

Syntax

Syntax:
[text, type, duration, animate] call BIS_fnc_3DENNotification
Parameters:
text: String - 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;

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