BIS fnc PIP: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Some wiki formatting)
(Add seealso link)
Line 11: Line 11:
|descr= Displays Picture in Picture.
|descr= Displays Picture in Picture.


|s1= [renderTarget, cameraParams, (vehicle, replace)] call [[BIS_fnc_PIP]]
|s1= [renderTarget, cameraParams, vehicle, replace] call [[BIS_fnc_PIP]]


|p1= '''renderTarget''': [[String]] - render target
|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]])


|p3= '''vehicle''' (Optional): [[Object]] - helicopter to which action is added (to memory point "action_screen1")
|p2= 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]])


|p4= '''replace''' (Optional): [[Boolean]] - true to replace existing PIP on same target (default: true)
|p3= vehicle: [[Object]] - (Optional) helicopter to which action is added (to memory point "action_screen1")


|r1=[[Object]] - camera
|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>
|r1= [[Object]] - camera
 
|x1= <code>["rendertarget0", [<nowiki/>[heli1, heli1 [[selectionPosition]] "slingload0"], cargo1], heli1, [[false]]] [[call]] [[BIS_fnc_PIP]];</code>


|x2= <code>["rendertarget0", _myCamera] [[call]] [[BIS_fnc_PIP]];</code>
|x2= <code>["rendertarget0", _myCamera] [[call]] [[BIS_fnc_PIP]];</code>


|seealso=
|seealso= [[isPiPEnabled]]
}}
}}

Revision as of 22:57, 21 June 2021

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
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