BIS fnc AAN: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
(Fix description, example and execution)
Line 1: Line 1:
 
{{Function|Comments=
{{Function|= Comments
____________________________________________________________________________________________
____________________________________________________________________________________________


| arma2oa |= Game name
| arma2oa |Game name=


|1.51|= Game version
|1.51|Game version=
____________________________________________________________________________________________
____________________________________________________________________________________________


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


| [parseText "Headline", parseText "Rolling Text"] spawn [[BIS_fnc_AAN]];|SYNTAX=
| [headline, rollingText] spawn [[BIS_fnc_AAN]] |SYNTAX=
 
|p1= headline: [[Structured Text]] - main title, shown in bigger size |Parameter 1=


|p1= [[Structured Text]] - Structured text for the Headline and Rolling Text. |=
|p2= rollingText: [[Structured Text]] - bottom text under ''headline'' scrolling right to left |Parameter 2=


| [[Nothing]] |RETURNVALUE=
| [[Nothing]] |RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________


|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> |=  
|x1= <code>[
[[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]];</code> |Example 1=
____________________________________________________________________________________________
____________________________________________________________________________________________
|exec= spawn |Execution=


| [[parseText]], [[BIS_fnc_showAANArticle]] |SEEALSO=
| [[parseText]], [[BIS_fnc_showAANArticle]] |SEEALSO=
}}
}}


Line 44: Line 49:
<dt class="note">[[User:Tryteyker-|Tryteyker-]]</dt>
<dt class="note">[[User:Tryteyker-|Tryteyker-]]</dt>
<dd class="note">
<dd class="note">
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>
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>
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>
</dl>
<!-- DISCONTINUE Notes -->


<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on August 5, 2015 - 22:38 (UTC)</dd>
<dd class="notedate">Posted on August 5, 2015 - 22:38 (UTC)</dd>
<dt class="note">[[User:Jaffa|Jaffa]]</dt>
<dt class="note">[[User:Jaffa|Jaffa]]</dt>
<dd class="note">
<dd class="note">
To remove the overlay you must close the display from the BIS_ANN 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>
<!-- DISCONTINUE Notes -->
<!-- DISCONTINUE Notes -->

Revision as of 12:54, 6 May 2019

A2 OA Logo.png1.51
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:
Uncategorised

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

Notes

Bottom Section

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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_AAN&oldid=123918"