BIS fnc cinemaBorder: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Text replacement - "(\|[pr][0-9]+ *= *[^-]+) *- *C([a-eg-z])" to "$1 - c$2")
 
(33 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Function|= Comments
{{RV|type=function
____________________________________________________________________________________________


| arma3 |= Game name
|game1= arma3
|version1= 1.00


|1.00|= Game version
|gr1= GUI
____________________________________________________________________________________________


|Creates cinematic borders. Player cannot move during cutscene.|DESCRIPTION=
|descr=Creates cinematic borders. Player cannot move during cutscene.
____________________________________________________________________________________________


| [mode, duration, sound, view] call [[BIS_fnc_cinemaBorder]] |SYNTAX=
|s1= [mode, duration, sound, view] call [[BIS_fnc_cinemaBorder]]
____________________________________________________________________________________________


|p1= mode: [[Number]] - Can be:
|p1= mode: [[Number]] - can be:
*0 - In
*0 - In
*1 - Out|= Parameter 1
*1 - Out
|p2= duration: [[Number]] - (Optional, default 1.5) Duration in seconds |= Parameter 2
|p2= duration: [[Number]] - (Optional, default 1.5) duration in seconds
|p3= sound: [[Boolean]] - (Optional, default [[false]]) Play sound |= Parameter 3
|p3= sound: [[Boolean]] - (Optional, default [[true]]) play sound
|p4= view: [[Boolean]] - (Optional, default [[false]] Lock 1st-person-view) |= Parameter 4
|p4= view: [[Boolean]] - (Optional, default [[false]]) lock 1st-person-view
____________________________________________________________________________________________


| [[Nothing]] |RETURNVALUE=
|r1= [[Nothing]]
____________________________________________________________________________________________


|x1= <code>[1, 2, [[true]], [[true]] ] [[call]] [[BIS_fnc_cinemaBorder]];</code> |=
|x1= <sqf>[1, 2, true, true] call BIS_fnc_cinemaBorder;</sqf>
____________________________________________________________________________________________


| [[disableUserInput]], [[userInputDisabled]] |SEEALSO=
|seealso= [[disableUserInput]] [[userInputDisabled]]
}}
}}


<h3 style="display:none">Notes</h3>
{{Note
<dl class="command_description">
|user= Honger
<!-- Note Section BEGIN -->
|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).
<!-- 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 13: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"