BIS fnc 3DENNotification: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision imported: BIS Functions update 7/7)
m (Text replacement - "since= Arma3" to "since= arma3")
 
(47 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{Function|=
{{RV|type=function
____________________________________________________________________________________________


| Arma 3 |= Game
|game1= arma3
|version1= 1.58


|1.58|= Game Version (number surrounded by NO SPACES)
|eff= Local


|arg= Local |= Multiplayer Arguments
|gr1= Eden Editor


|eff= Local |= Multiplayer Effects
|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.
The sound is played through the UI channel with [[playSoundUI]].


| Show notification in the Eden Editor |= Description
|s1= [text, type, duration, animate] call [[BIS_fnc_3DENNotification]]
____________________________________________________________________________________________


| [Text,Type,Duration,Animate] |= Syntax
|p1= text: [[String]] or [[Structured Text]] - either text or class from <sqf inline>"Cfg3DEN" >> "Notifications"</sqf>


|p1= Text: [[String]] - Either text or class from Cfg3DEN >> Notifications  |= Parameter 1
|p2= type: [[Number]] - (Optional, default 0) 0: Notification (Green) 1: Warning (Red)


|p2= (Optional) Type: [[Number]] - 0: Notification (Green,default) 1: Warning (Red) |= Parameter 2
|p3= duration: [[Number]] - (Optional, default 2) duration in seconds (+ 1 sec for each new line)


|p3= (Optional) Duration: [[Number]] - Duration (Default 2 sec. + 1 sec for each new line) |= Parameter 3
|p4= animate: [[Boolean]] - (Optional, default [[true]]) toggle animation


|p4= (Optional) Animate: [[Bool]] - Animation (Default: true) |= Parameter 4
|p5= volume: [[Number]] - (Optional, default 1) volume adjustment
|p5since= arma3 2.10


| [Number] - Selected Mode |= Return Value
|r1= [[Number]] - selected Mode
|exec= call |= Execution By (defaults to [[call]] if omitted)
__________________________________________________________________________________________


|x1= ["This is an animated notification.",0] [[call]] [[BIS_fnc_3DENNotification]] |= Example 1
|x1= <sqf>["This is an animated notification", 0] call BIS_fnc_3DENNotification;</sqf>
____________________________________________________________________________________________


|x2= ["This is a warning which is not animated.",1] [[call]] [[BIS_fnc_3DENNotification]] |= Example 2
|x2= <sqf>["This is a warning that is not animated", 1, 2, false] call BIS_fnc_3DENNotification;</sqf>
____________________________________________________________________________________________


| SEEALSO |= See Also
|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]]
}}
}}
<dl class="command_description">
<!-- BEGIN Note Section -->
<!-- For example:
<dd class="notedate">Posted on Month Day, Year - Time (UTC)</dd>
<dt class="note">'''[[User:User Name|User Name]]'''</dt>
<dd class="note">This is an example note. It is true and verifiable, and contains a little code snippet.
<code>[[if]] ([[_this]] == anExample) [[then]] { [[hint]] "Leave it here for others to read"; };</code></dd>
-->
<!-- END Note Section -->
</dl>
<h3 style="display:none">Bottom Section</h3>
<!-- Appropriate categories go here -->
[[Category:Arma 3: Functions|{{uc:{{PAGENAME}}}}]]

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"