BIS fnc AAN: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <!-- (DIS)?CONTINUE Notes -->" to "")
m (Some wiki formatting)
Line 1: Line 1:
{{RV|type=function
{{RV|type=function


| arma2oa
|game1= arma2oa
|version1= 1.50


|1.51
|game2= tkoh
|version2= 1.00
 
|game3= arma3
|version3= 0.50


|gr1= GUI
|gr1= GUI


| Add an AAN overlay to the screen, with one headline and a rolling text on the bottom.
|descr= Add an AAN overlay to the screen, with one headline and a rolling text on the bottom.


| [headline, rollingText] spawn [[BIS_fnc_AAN]]
|s1= [headline, rollingText] spawn [[BIS_fnc_AAN]]


|p1= headline: [[Structured Text]] - main title, shown in bigger size
|p1= headline: [[Structured Text]] - main title, shown in bigger size
Line 15: Line 20:
|p2= rollingText: [[Structured Text]] - bottom text under ''headline'' scrolling right to left
|p2= rollingText: [[Structured Text]] - bottom text under ''headline'' scrolling right to left


| [[Nothing]]
|r1= [[Nothing]]


|x1= <code>[
|x1= <code>[
Line 27: Line 32:
}}
}}


<dl class="command_description">


[[Category:{{Name|arma2oa}}: Functions|{{uc:AAN}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:AAN}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:AAN}}]]
<dl class="command_description">
<dt></dt>
<dt></dt>
<dd class="notedate">Posted on September 28, 2014 - 19:42 (UTC)</dd>
<dd class="notedate">Posted on September 28, 2014 - 19:42 (UTC)</dd>
Line 41: Line 41:
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.
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>
</dd>
<dt><dt>
<dt><dt>
<dd class="notedate">Posted on August 5, 2015 - 22:38 (UTC)</dd>
<dd class="notedate">Posted on August 5, 2015 - 22:38 (UTC)</dd>
Line 46: Line 47:
<dd class="note">
<dd class="note">
To remove the overlay you must close the display from the BIS_AAN UI Namespace variable.  
To remove the overlay you must close the display from the BIS_AAN UI Namespace variable.  
i.e. <code>([[uiNamespace]] [[getVariable]] "BIS_AAN") [[closeDisplay]] 1</code>
i.e. <code>([[uiNamespace]] [[getVariable]] "BIS_AAN") [[closeDisplay]] 1;</code>
</dd>
</dd>
</dl>
</dl>

Revision as of 10:26, 9 June 2021

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:
parseTextBIS_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
Posted on September 28, 2014 - 19:42 (UTC)
Tryteyker-
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.
Posted on August 5, 2015 - 22:38 (UTC)
Jaffa
To remove the overlay you must close the display from the BIS_AAN UI Namespace variable. i.e. (uiNamespace getVariable "BIS_AAN") closeDisplay 1;