BIS fnc titlecard: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *P([a-gi-z ])" to "$1 - p$2")
 
(32 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma3
____________________________________________________________________________________________
|version1= 1.00


| arma3 |= Game name
|gr1= GUI


|1.00|= Game version
|descr= Display a mission-specific titlecard before the mission begins. Only works the first time it is called.
____________________________________________________________________________________________


| <pre>/*
|s1= [path, subtitle] call [[BIS_fnc_titlecard]]
Description:
Display a mission-specific titlecard before the mission begins.
Parameters:
0: STRING - Path to video file
1 (Optional): Subtitle visible when language is not English
*/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
|p1= path: [[String]] - path to video
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_titlecard]]; --> |= Syntax
|p2= subtitle: [[String]] - (Optional, default "") subtitle displayed|r1= [[Boolean]]


|p1= |= Parameter 1
|x1= <sqf>["\a3\missions_f_epb\video\b_out2_quotation.ogv", "your translation"] call BIS_fnc_titlecard;</sqf>
 
| |= Return value
____________________________________________________________________________________________
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| |= See also


|seealso= [[allCutLayers]] [[titleRsc]] [[cutText]] [[cutObj]] [[cutFadeOut]] [[setTitleEffect]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: GUI|{{uc:titlecard}}]]
[[Category:Functions|{{uc:titlecard}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:titlecard}}]]

Latest revision as of 16:45, 8 November 2023

Arma 3 logo black.png1.00
Hover & click on the images for description

Description

Description:
Display a mission-specific titlecard before the mission begins. Only works the first time it is called.
Execution:
call
Groups:
GUI

Syntax

Syntax:
[path, subtitle] call BIS_fnc_titlecard
Parameters:
path: String - path to video
subtitle: String - (Optional, default "") subtitle displayed
Return Value:
Boolean

Examples

Example 1:
["\a3\missions_f_epb\video\b_out2_quotation.ogv", "your translation"] call BIS_fnc_titlecard;

Additional Information

See also:
allCutLayers titleRsc cutText cutObj cutFadeOut setTitleEffect

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_titlecard&oldid=348972"