BIS fnc PIP: Difference between revisions

Latest revision as of 19:04, 5 May 2022

1.00

0.50

Hover & click on the images for description

Description

Description:: Displays Picture in Picture.
Execution:: call
Groups:: GUI

Syntax

Syntax:

[renderTarget, cameraParams, vehicle, replace] call BIS_fnc_PIP

Parameters:

renderTarget: String - render target

cameraParams: Object or Array

Object - existing camera
Array - camera params in format [position, target]:
- position: Array in format Position3D or attachTo [object, position]
- target: Object or Array in format Position3D (same as camPrepareTarget)

vehicle: Object - (Optional) helicopter to which action is added (to memory point "action_screen1")

replace: Boolean - (Optional, default true) true to replace existing PIP on same target

Return Value:

Object - camera

Examples

Example 1:: ["rendertarget0", [heli1, heli1 selectionPosition "slingload0"], cargo1], heli1, false] call BIS_fnc_PIP;
Example 2:: ["rendertarget0", _myCamera] call BIS_fnc_PIP;

Additional Information

See also:: isPiPEnabled

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

@@ Line 1: / Line 1: @@
+{{RV|type=function
-{{Function|= Comments
+|game1= tkoh
-____________________________________________________________________________________________
+|version1= 1.00
-| tkoh |= Game name
+|game2= arma3
+|version2= 0.50
-|1.00|= Game version
+|gr1= GUI
-____________________________________________________________________________________________
-| <pre>/*
+|descr= Displays Picture in Picture.
-	Description:
+|s1= [renderTarget, cameraParams, vehicle, replace] call [[BIS_fnc_PIP]]
-	Displays Picture in Picture
-	When empty array [] is passed as argument, current camera is terminated
-	Parameter(s):
+|p1= renderTarget: [[String]] - render target
-	_this select 0: STRING - render target
-	_this select 1: OBJECT or ARRAY - camera or camera params in format [position,target]
-	_this select 2: OBJECT - helicopter to which action is added (to memory point "action_screen1")
-	_this select 3 (Optional): BOOL - true to replace existing PIP on same target (default: true)
-	Returns:
+|p2= cameraParams: [[Object]] or [[Array]]
-	OBJECT - camera
+* [[Object]] - existing camera
-*/
+* [[Array]] - camera params in format [position, target]:
-</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
+** position: [[Array]] in format [[Position#Introduction|Position3D]] or [[attachTo]] [object, position]
-____________________________________________________________________________________________
+** target: [[Object]] or [[Array]] in format [[Position#Introduction|Position3D]] (same as [[camPrepareTarget]])
-| <!-- [] call [[BIS_fnc_PIP]]; --> |= Syntax
+|p3= vehicle: [[Object]] - (Optional) helicopter to which action is added (to memory point "action_screen1")
-|p1= |= Parameter 1
+|p4= replace: [[Boolean]] - (Optional, default [[true]]) true to replace existing PIP on same target
-| |= Return value
+|r1= [[Object]] - camera
-____________________________________________________________________________________________
-|x1= <code></code> |=
+|x1= <sqf>["rendertarget0", [heli1, heli1 selectionPosition "slingload0"], cargo1], heli1, false] call BIS_fnc_PIP;</sqf>
-____________________________________________________________________________________________
-| |= See also
+|x2= <sqf>["rendertarget0", _myCamera] call BIS_fnc_PIP;</sqf>
+|seealso= [[isPiPEnabled]]
 }}
-<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:PIP}}]]
-[[Category:Functions|{{uc:PIP}}]]
-[[Category:{{Name|tkoh}}: Functions|{{uc:PIP}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:PIP}}]]