BIS fnc cinemaBorder: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " *\|= " to " ")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)
Line 1: Line 1:
{{Function|Comments=
{{Function


| arma3 |Game name=
| arma3


|1.00|Game version=
|1.00


|gr1= GUI |GROUP1=
|gr1= GUI


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


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


|p1= mode: [[Number]] - Can be:
|p1= mode: [[Number]] - Can be:
*0 - In
*0 - In
*1 - Out|PARAMETER1=
*1 - Out
|p2= duration: [[Number]] - (Optional, default 1.5) Duration in seconds |PARAMETER2=
|p2= duration: [[Number]] - (Optional, default 1.5) Duration in seconds
|p3= sound: [[Boolean]] - (Optional, default [[false]]) Play sound |PARAMETER3=
|p3= sound: [[Boolean]] - (Optional, default [[false]]) Play sound
|p4= view: [[Boolean]] - (Optional, default [[false]] Lock 1st-person-view) |PARAMETER4=
|p4= view: [[Boolean]] - (Optional, default [[false]] Lock 1st-person-view)


| [[Nothing]] |RETURNVALUE=
| [[Nothing]]


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


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



Revision as of 23:37, 17 January 2021

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 false) 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:
disableUserInputuserInputDisabled

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


Bottom Section