BIS fnc AAN: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1.51)
m (Some wiki formatting)
 
(27 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma2oa
____________________________________________________________________________________________
|version1= 1.50


| arma2oa |= Game name
|game2= tkoh
|version2= 1.00


|1.51|= Game version
|game3= arma3
____________________________________________________________________________________________
|version3= 0.50


| Function that adds an AAN overlay to the screen, with one headline and a rolling text on the bottom. |= Description
|gr1= GUI
____________________________________________________________________________________________


| [parseText "Headline", parseText "Rolling Text"] spawn [[BIS_fnc_AAN]];|= Syntax
|descr= Add an AAN overlay to the screen, with one headline and a rolling text on the bottom.


|p1= [[Structured Text]] - Structured text for the Headline and Rolling Text. |=
|s1= [headline, rollingText] spawn [[BIS_fnc_AAN]]


| [[Nothing]] |= Return value
|p1= headline: [[Structured Text]] - main title, shown in bigger size
____________________________________________________________________________________________


|x1= <code>0 = [parseText "AAN live in Takistan", parseText "Weather coming up hot and steamy - Takistan shelled again from border area"] spawn BIS_fnc_AAN;</code> |=
|p2= rollingText: [[Structured Text]] - bottom text under ''headline'' scrolling right to left
____________________________________________________________________________________________


| [[parseText]] |= See also
|r1= [[Nothing]]


}}
|x1= <sqf>
[
parseText "<t size='2'>AAN live in Takistan</t>",
parseText "Weather coming up hot and steamy - Takistan shelled again from border area"
] spawn BIS_fnc_AAN;
</sqf>


<h3 style="display:none">Notes</h3>
|exec= spawn
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|seealso= [[parseText]] [[BIS_fnc_showAANArticle]]
</dl>
}}


<h3 style="display:none">Bottom Section</h3>
{{Note
[[Category:Function Group: GUI|{{uc:AAN}}]]
|user= Triteyker-
[[Category:Functions|{{uc:AAN}}]]
|timestamp= 20140928194200
[[Category:{{Name|arma2oa}}: Functions|{{uc:AAN}}]]
|text= Maximum size (added with <t size='x'></t> parameters) for the headline is 2 if you want another, size 1 text under it. Size 2.5 to 3 seems to be the max size for the headline if you don't want it to disappear.<br>
[[Category:{{Name|tkoh}}: Functions|{{uc:AAN}}]]
Rolling text size has to be 1 or else it disappears entirely. Time in the bottom right is ingame time (see [[setDate]]). Do note that this function cannot center on an object, and additional camera work is required to achieve such effects. It merely adds an overlay to the screen, and the player retains control even with the overlay active.
[[Category:{{Name|arma3}}: Functions|{{uc:AAN}}]]
}}


<!-- CONTINUE Notes -->
{{Note
<dl class="command_description">
|user= Jaffa
<dd class="notedate">Posted on September 28, 2014 - 19:42 (UTC)</dd>
|timestamp= 20150805223800
<dt class="note">[[User:Tryteyker-|Tryteyker-]]</dt>
|text= To remove the overlay you must close the display from the BIS_AAN UI Namespace variable.  
<dd class="note">
i.e. <sqf>(uiNamespace getVariable "BIS_AAN") closeDisplay 1;</sqf>
Maximum size (added with <t size='1'></t> parameters) for the headline is 2 if you want another, size 1 text under it. Size 2.5 to 3 seems to be the max size for the headline if you don't want it to disappear.<br>
}}
Rolling text size has to be 1 or else it disappears entirely. Time in the bottom right is ingame time (see [[setDate]]). Do note that this function cannot center on an object, and additional camera work is required to achieve such effects. It merely adds an overlay to the screen, and the player retains control even with the overlay active.
</dd>
</dl>
<!-- DISCONTINUE Notes -->

Latest revision as of 17:04, 13 July 2022

A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
Hover & click on the images for description

Description

Description:
Add an AAN overlay to the screen, with one headline and a rolling text on the bottom.
Execution:
spawn
Groups:
GUI

Syntax

Syntax:
[headline, rollingText] spawn BIS_fnc_AAN
Parameters:
headline: Structured Text - main title, shown in bigger size
rollingText: Structured Text - bottom text under headline scrolling right to left
Return Value:
Nothing

Examples

Example 1:
[ parseText "<t size='2'>AAN live in Takistan</t>", parseText "Weather coming up hot and steamy - Takistan shelled again from border area" ] spawn BIS_fnc_AAN;

Additional Information

See also:
parseText BIS_fnc_showAANArticle

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
Triteyker- - c
Posted on Sep 28, 2014 - 19:42 (UTC)
Maximum size (added with <t size='x'></t> parameters) for the headline is 2 if you want another, size 1 text under it. Size 2.5 to 3 seems to be the max size for the headline if you don't want it to disappear.
Rolling text size has to be 1 or else it disappears entirely. Time in the bottom right is ingame time (see setDate). Do note that this function cannot center on an object, and additional camera work is required to achieve such effects. It merely adds an overlay to the screen, and the player retains control even with the overlay active.
Jaffa - c
Posted on Aug 05, 2015 - 22:38 (UTC)
To remove the overlay you must close the display from the BIS_AAN UI Namespace variable. i.e.
(uiNamespace getVariable "BIS_AAN") closeDisplay 1;
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_AAN&oldid=328448"