{"name":"BIS_fnc_3DENNotification","operator":null,"title":"BIS fnc 3DENNotification","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_3DENNotification","revid":352420,"updated":"2024-02-09T15:26:08Z","groups":["Eden Editor"],"status":"ok","replaced_by":[],"games":[{"game":"arma3","name":"Arma 3","version":"1.58"}],"since":{"game":"arma3","name":"Arma 3","version":"1.58"},"arma3_since":"1.58","branch":null,"locality":{"argument":null,"effect":"local","server_exec":false},"exec":null,"description":"Shows notification banner with given text, animated or not, at the top of the screen in the Eden Editor.\n\nSince Arma 3 v2.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.\nThe sound is played through the UI channel with playSoundUI.","syntaxes":[{"syntax":"[text, type, duration, animate] call BIS_fnc_3DENNotification","since":null,"effect":null,"exec":null,"params":[{"name":"text","type":"String or Structured Text","optional":false,"default":null,"description":"either text or class from `\"Cfg3DEN\" >> \"Notifications\"`","types":["String","Structured Text"],"since":null,"text":"text: String or Structured Text - either text or class from `\"Cfg3DEN\" >> \"Notifications\"`"},{"name":"type","type":"Number","optional":true,"default":"0","description":"0: Notification (Green) 1: Warning (Red)","types":["Number"],"since":null,"text":"type: Number - (Optional, default 0) 0: Notification (Green) 1: Warning (Red)"},{"name":"duration","type":"Number","optional":true,"default":"2","description":"duration in seconds (+ 1 sec for each new line)","types":["Number"],"since":null,"text":"duration: Number - (Optional, default 2) duration in seconds (+ 1 sec for each new line)"},{"name":"animate","type":"Boolean","optional":true,"default":"true","description":"toggle animation","types":["Boolean"],"since":null,"text":"animate: Boolean - (Optional, default true) toggle animation"},{"name":"volume","type":"Number","optional":true,"default":"1","description":"volume adjustment","types":["Number"],"since":"arma3 2.10","text":"volume: Number - (Optional, default 1) volume adjustment"}],"returns":{"type":"Number","types":["Number"],"description":"selected Mode","text":"Number - selected Mode"}}],"examples":[{"text":"```sqf\n[\"This is an animated notification\", 0] call BIS_fnc_3DENNotification;\n```","code":["[\"This is an animated notification\", 0] call BIS_fnc_3DENNotification;"]},{"text":"```sqf\n[\"This is a warning that is not animated\", 1, 2, false] call BIS_fnc_3DENNotification;\n```","code":["[\"This is a warning that is not animated\", 1, 2, false] call BIS_fnc_3DENNotification;"]},{"text":"```sqf\n[\"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;\n```","code":["[\"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;"]}],"multiplayer":null,"problems":null,"aliases":[],"see_also":["BIS_fnc_3DENShowMessage"],"notes":[],"categories":["Arma 3: Functions","Arma 3: New Functions","Function Group: Eden Editor","Functions","Functions: Local Effect","Introduced with Arma 3 version 1.58"],"docblock":null,"filled_from_docblock":[]}