BIS fnc cinemaBorder: 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]+ *= *[^-]+) *- *C([a-eg-z])" to "$1 - c$2")
 
(36 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=Creates cinematic borders. Player cannot move during cutscene.
____________________________________________________________________________________________


| <pre>/*
|s1= [mode, duration, sound, view] call [[BIS_fnc_cinemaBorder]]


Description:
|p1= mode: [[Number]] - can be:
Moves camera borders.
*0 - In
*1 - Out
|p2= duration: [[Number]] - (Optional, default 1.5) duration in seconds
|p3= sound: [[Boolean]] - (Optional, default [[true]]) play sound
|p4= view: [[Boolean]] - (Optional, default [[false]]) lock 1st-person-view


Parameter(s):
|r1= [[Nothing]]
_this select 0: NUMBER - Mode (0 - in, 1 - out)
_this select 1: NUMBER - Duration in seconds (default - 1.5)
_this select 2: BOOL - Play sound (default - true)
_this select 3: BOOL - lock 1st person view (default - false)


Returns:
|x1= <sqf>[1, 2, true, true] call BIS_fnc_cinemaBorder;</sqf>
Nothing
*/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
|seealso= [[disableUserInput]] [[userInputDisabled]]
____________________________________________________________________________________________
}}
 
| <!-- [] call [[BIS_fnc_cinemaBorder]]; --> |= Syntax
 
|p1= |= Parameter 1
 
| |= Return value
____________________________________________________________________________________________
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| |= See also


{{Note
|user= Honger
|timestamp= 20221015144335
|text= When cinematic borders are active and player is not provided with any animation, he can abuse the movement lock by vaulting (default button V).
}}
}}
<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:cinemaBorder}}]]
[[Category:Functions|{{uc:cinemaBorder}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:cinemaBorder}}]]

Latest revision as of 14:59, 8 November 2023

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

Description

Description:
Creates cinematic borders. Player cannot move during cutscene.
Execution:
call
Groups:
GUI

Syntax

Syntax:
[mode, duration, sound, view] call BIS_fnc_cinemaBorder
Parameters:
mode: Number - can be:
  • 0 - In
  • 1 - Out
duration: Number - (Optional, default 1.5) duration in seconds
sound: Boolean - (Optional, default true) play sound
view: Boolean - (Optional, default false) lock 1st-person-view
Return Value:
Nothing

Examples

Example 1:
[1, 2, true, true] call BIS_fnc_cinemaBorder;

Additional Information

See also:
disableUserInput userInputDisabled

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
Honger - c
Posted on Oct 15, 2022 - 14:43 (UTC)
When cinematic borders are active and player is not provided with any animation, he can abuse the movement lock by vaulting (default button V).
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_cinemaBorder&oldid=348331"