BIS fnc dynamicText: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Example)
m (That nowiki stuff was unnecessary)
 
(39 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.00|= Game version
|game3= arma3
____________________________________________________________________________________________
|version3= 0.50


| <pre>/*
|gr1= GUI
File: credits.sqf


Description:
|eff= local
Dynamic opening credits


Parameter(s):
|descr= Shows dynamic opening credits or any type of text.<br>
_this select 0: Text
[[File:BIS_fnc_dynamicText_v2.gif|left|400px]]
_this select 1: (Optional) X coordinates
_this select 2: (Optional) Y coordinates
_this select 3: (Optional) Duration
_this select 4: (Optional) Fadein time
_this select 5: (Optional) Delta Y
_this select 6: (Optional) Resource layer
*/
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_dynamicText]]; --> |= Syntax
|s1= [text, x, y, duration, fadeInTime, deltaY, rscLayer] spawn [[BIS_fnc_dynamicText]]


|p1= |= Parameter 1
|p1= text: [[String]] - text to display


| |= Return value
|p2= x: [[Number]] or [[Array]] - (Optional, default -1)
____________________________________________________________________________________________
* [[Number]] - Position in x
* [[Array]]
** 0: Position in x
** 1: Width of the control


|x1= <code>["<t color='#ff0000' size = '.8'>Warning!<nowiki><br /></nowiki>Stop doing what you are doing</t>",-1,-1,4,1,0,789] spawn [[BIS_fnc_dynamicText]];</code> |=
|p3= y: [[Number]] or [[Array]] - (Optional, default -1)
____________________________________________________________________________________________
* [[Number]] - Position in y
* [[Array]]
** 0: Position in y
** 1: Height of the control


| |= See also
|p4= duration: [[Number]] - (Optional, default 4) display duration


}}
|p5= fadeInTime: [[Number]] - (Optional, default 1) fade-in time
 
|p6= deltaY: [[Number]] - (Optional, default 0) Y position delta:
* = 0: Text will not move
* > 0: Text will move down
* < 0: Text will move up
''duration'' and the absolute ''deltaY'' value will influence the movement speed.
 
|p7= rscLayer: [[Number]] - resource layer
 
|r1= [[Nothing]]


<h3 style="display:none">Notes</h3>
|x1= <sqf>["<t color='#ff0000' size='.8'>Warning!<br />Stop doing what you are doing</t>",-1,-1,4,1,0,789] spawn BIS_fnc_dynamicText;</sqf>
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|exec= spawn
</dl>


<h3 style="display:none">Bottom Section</h3>
|seealso= [[BIS_fnc_infoText]] [[BIS_fnc_textTiles]] [[BIS_fnc_typeText]] [[BIS_fnc_typeText2]] [[BIS_fnc_EXP_camp_SITREP]]
[[Category:Function Group: GUI|{{uc:dynamicText}}]]
}}
[[Category:Functions|{{uc:dynamicText}}]]
[[Category:{{Name|arma2oa}}: Functions|{{uc:dynamicText}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:dynamicText}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:dynamicText}}]]

Latest revision as of 18:13, 21 October 2022

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

Description

Description:
Shows dynamic opening credits or any type of text.
BIS fnc dynamicText v2.gif
Execution:
spawn
Groups:
GUI

Syntax

Syntax:
[text, x, y, duration, fadeInTime, deltaY, rscLayer] spawn BIS_fnc_dynamicText
Parameters:
text: String - text to display
x: Number or Array - (Optional, default -1)
  • Number - Position in x
  • Array
    • 0: Position in x
    • 1: Width of the control
y: Number or Array - (Optional, default -1)
  • Number - Position in y
  • Array
    • 0: Position in y
    • 1: Height of the control
duration: Number - (Optional, default 4) display duration
fadeInTime: Number - (Optional, default 1) fade-in time
deltaY: Number - (Optional, default 0) Y position delta:
  • = 0: Text will not move
  • > 0: Text will move down
  • < 0: Text will move up
duration and the absolute deltaY value will influence the movement speed.
rscLayer: Number - resource layer
Return Value:
Nothing

Examples

Example 1:
["<t color='#ff0000' size='.8'>Warning!<br />Stop doing what you are doing</t>",-1,-1,4,1,0,789] spawn BIS_fnc_dynamicText;

Additional Information

See also:
BIS_fnc_infoText BIS_fnc_textTiles BIS_fnc_typeText BIS_fnc_typeText2 BIS_fnc_EXP_camp_SITREP

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_dynamicText&oldid=330683"