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: @@
-{{Function|Comments=
+{{RV|type=function
-____________________________________________________________________________________________
-| TKOH |Game name=
+|game1= tkoh
+|version1= 1.00
-|1.00|Game version=
+|game2= arma3
+|version2= 0.50
-|gr1= GUI |GROUP1=
+|gr1= GUI
-____________________________________________________________________________________________
-| Displays Picture in Picture. |DESCRIPTION=
+|descr= Displays Picture in Picture.
-____________________________________________________________________________________________
-| [renderTarget, cameraParams, (vehicle, replace)] call bis_fnc_PIP; |SYNTAX=
+|s1= [renderTarget, cameraParams, vehicle, replace] call [[BIS_fnc_PIP]]
-|p1= '''renderTarget''': [[String]] - render target |Parameter1=
+|p1= renderTarget: [[String]] - render target
-|p2= '''cameraParams''':
-<br>[[Object]] - existing camera
-<br>[[Array]] - camera params in format [position,target].
-<br>'''position''': [[Array]] in format [[Position3D]] or [[attachTo]] [object,position]
-<br>'''target''': [[Object]] or [[Array]] in format [[Position3D]] (same as [[camPrepareTarget]]) |Parameter2=
-|p3= '''vehicle''' (Optional): [[Object]] - helicopter to which action is added (to memory point "action_screen1") |PARAMETER3=
+|p2= cameraParams: [[Object]] or [[Array]]
+* [[Object]] - existing camera
+* [[Array]] - camera params in format [position, target]:
+** position: [[Array]] in format [[Position#Introduction|Position3D]] or [[attachTo]] [object, position]
+** target: [[Object]] or [[Array]] in format [[Position#Introduction|Position3D]] (same as [[camPrepareTarget]])
-|p4= '''vehicle''' (Optional): [[Boolean]] - true to replace existing PIP on same target (default: true) |PARAMETER4=
+|p3= vehicle: [[Object]] - (Optional) helicopter to which action is added (to memory point "action_screen1")
-| [[Object]] - camera |RETURNVALUE=
+|p4= replace: [[Boolean]] - (Optional, default [[true]]) true to replace existing PIP on same target
-____________________________________________________________________________________________
-|x1= <code>["rendertarget0",<nowiki>[</nowiki>[heli1,heli1 selectionposition "slingload0"],cargo1],heli1,false] call BIS_fnc_PIP;</code> |Example1=
-|x2= <code>["rendertarget0",_myCamera] call BIS_fnc_PIP;</code> |EXAMPLE2=
+|r1= [[Object]] - camera
-____________________________________________________________________________________________
-| |SEEALSO=
+|x1= <sqf>["rendertarget0", [heli1, heli1 selectionPosition "slingload0"], cargo1], heli1, false] call BIS_fnc_PIP;</sqf>
+|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:Functions|{{uc:PIP}}]]
-[[Category:{{Name|tkoh}}: Functions|{{uc:PIP}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:PIP}}]]