BIS fnc customGPSVideo: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Changed layout template from Command to Function)
m (Fix)
 
(47 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Function|=
{{RV|type=function
____________________________________________________________________________________________


| arma2oa |=
|game1= arma2oa
|version1= 1.56


|1.56|=
|game2= tkoh
|version2= 1.00


|arg= |= MPARGUMENTS
|game3= arma3
|version3= 0.50


|eff= local |= Effects in MP
|gr1= GUI
____________________________________________________________________________________________


| Plays in-game video in GPS frame.
|eff= local
<br>
If [[BIS fnc customGPS]] changed GPS texture, it's used.
<br>
GUI layer for GPS is <tt>19</tt>.|=
____________________________________________________________________________________________


| [path,''sizeCoef''] call '''BIS_fnc_customGPSvideo'''  |=
|descr= Plays in-game video in GPS frame.<br>
If [[BIS_fnc_customGPS]] changed the GPS texture, it is used. GPS GUI layer is {{hl|19}}.
{{Feature|arma3|Does not work in {{arma3}}. See [[BIS_fnc_playVideo]] instead.}}


|p1= path: [[String]] - full path to image file |= PARAMETER1
|s1= [path, sizeCoef] spawn '''BIS_fnc_customGPSVideo'''


|p2= sizeCoef ''(Optional)'': [[Number]] - screen size coeficient (default is 1) |= PARAMETER2
|p1= path: [[String]] - full path to image file


| [[Script_(Handle)|Script]] - script which terminates itself once video ends |= RETURNVALUE
|p2= sizeCoef: [[Number]] - (Optional, default 1) screen size coefficient


|x1= <code>_script = ["\ca\video_pmc\CP00_Reynolds_b.ogv",1.04] [[spawn]] [[BIS_fnc_customGPSvideo]];
|r1= [[Script Handle]] - script which terminates itself once video ends
[[waitUntil]] {[[scriptDone]] _script};</code>|= EXAMPLE1
____________________________________________________________________________________________


| [[Functions Library]] |= SEEALSO
|x1= <sqf>
private _script = ["\ca\video_pmc\CP00_Reynolds_b.ogv", 1.04] spawn BIS_fnc_customGPSVideo;
waitUntil { scriptDone _script };
</sqf>


| |= MPBEHAVIOUR
|exec= spawn
____________________________________________________________________________________________
 
|seealso= [[BIS_fnc_playVideo]] [[BIS_fnc_customGPS]]
}}
}}
<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:ArmA 2: Functions|CUSTOMGPSVIDEO}}]]
[[Category:Function Group: GUI|customGPSvideo]]

Latest revision as of 10:31, 16 July 2024

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

Description

Description:
Plays in-game video in GPS frame.
If BIS_fnc_customGPS changed the GPS texture, it is used. GPS GUI layer is 19.
Arma 3
Does not work in Arma 3. See BIS_fnc_playVideo instead.
Execution:
spawn
Groups:
GUI

Syntax

Syntax:
[path, sizeCoef] spawn BIS_fnc_customGPSVideo
Parameters:
path: String - full path to image file
sizeCoef: Number - (Optional, default 1) screen size coefficient
Return Value:
Script Handle - script which terminates itself once video ends

Examples

Example 1:
private _script = ["\ca\video_pmc\CP00_Reynolds_b.ogv", 1.04] spawn BIS_fnc_customGPSVideo; waitUntil { scriptDone _script };

Additional Information

See also:
BIS_fnc_playVideo BIS_fnc_customGPS

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_customGPSVideo&oldid=365057"