BIS fnc playVideo: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
mNo edit summary
Line 1: Line 1:
 
{{Command|=
{{Function|= Comments
____________________________________________________________________________________________
____________________________________________________________________________________________


| arma2oa |= Game name
| arma2oa |=


|1.00|= Game version
|1.56|=
____________________________________________________________________________________________


| <pre>
|arg= |= MPARGUMENTS
/*


Description:
|eff= local |= Effects in MP
Plays in-game video.
____________________________________________________________________________________________


Parameter(s):
| Plays in-game video.<br /><br />GUI layer for video is 25.<br /><br />Script terminates itself when video stops.
_this select 0: STRING - Video path
|=
_this select 1 (Optional): ARRAY - Size
____________________________________________________________________________________________
_this select 2 (Optional): ARRAY - Color
_this select 3 (Optional): STRING - Variable to skip the video


Returns:
| [path,''size'',''color''] call '''BIS_fnc_playVideo'''  |=
True
*/


#define VIDEO_DISPLAY (uinamespace getvariable "BIS_RscMissionScreen_video")
|p1= path: [[String]] - full path to OGV file |= PARAMETER1
#define VIDEO_CONTENT (VIDEO_DISPLAY displayctrl 1100)


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
|p2= size ''(Optional)'': [[Array]] in format [x, y, w, h] |= PARAMETER2
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_playVideo]]; --> |= Syntax
|p3= color ''(Optional)'': [[Array]] in format [[Color]] |= PARAMETER3


|p1= |= Parameter 1
| [[Nothing]] |= RETURNVALUE


| |= Return value
|x1= <code>_video <nowiki>=</nowiki> ["\ca\video_pmc\CP00_intro.ogv"] [[spawn]] bis_fnc_playVideo;<br />[[waitUntil]] {[[scriptDone]] _video};</code>|= EXAMPLE1
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code></code> |=  
| [[Functions Library]] |= SEEALSO
 
|  |= MPBEHAVIOUR
____________________________________________________________________________________________
____________________________________________________________________________________________
| |= See also
}}
}}


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


Line 51: Line 41:
</dl>
</dl>


<h3 style="display:none">Bottom Section</h3>
<h3 style='display:none'>Bottom Section</h3>
[[Category:Function Group: GUI|{{uc:playVideo}}]]
 
[[Category:Functions|{{uc:playVideo}}]]
[[Category:ArmA 2: Functions|PLAYVIDEO}}]]
[[Category:{{Name|arma2oa}}: Functions|{{uc:playVideo}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:playVideo}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:playVideo}}]]

Revision as of 12:09, 29 November 2010

A2 OA Logo.png1.56
LELocal
Hover & click on the images for description

Description

Description:
Plays in-game video.

GUI layer for video is 25.

Script terminates itself when video stops.
Groups:
Uncategorised

Syntax

Syntax:
[path,size,color] call BIS_fnc_playVideo
Parameters:
path: String - full path to OGV file
size (Optional): Array in format [x, y, w, h]
color (Optional): Array in format Color
Return Value:
Nothing

Examples

Example 1:
_video = ["\ca\video_pmc\CP00_intro.ogv"] spawn bis_fnc_playVideo;
waitUntil {scriptDone _video};

Additional Information

See also:
Functions Library

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

Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_playVideo&oldid=58930"