BIS fnc PIP: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl>" 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


| TKOH |Game name=
| TKOH


|1.00|Game version=
|1.00


|gr1= GUI |GROUP1=
|gr1= GUI


| Displays Picture in Picture. |DESCRIPTION=
| Displays Picture in Picture.


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


|p1= '''renderTarget''': [[String]] - render target |Parameter1=
|p1= '''renderTarget''': [[String]] - render target
|p2= '''cameraParams''':
|p2= '''cameraParams''':
<br>[[Object]] - existing camera
<br>[[Object]] - existing camera
<br>[[Array]] - camera params in format [position,target].
<br>[[Array]] - camera params in format [position,target].
<br>'''position''': [[Array]] in format [[Position3D]] or [[attachTo]] [object,position]
<br>'''position''': [[Array]] in format [[Position3D]] or [[attachTo]] [object,position]
<br>'''target''': [[Object]] or [[Array]] in format [[Position3D]] (same as [[camPrepareTarget]]) |Parameter2=
<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") |PARAMETER3=
|p3= '''vehicle''' (Optional): [[Object]] - helicopter to which action is added (to memory point "action_screen1")


|p4= '''replace''' (Optional): [[Boolean]] - true to replace existing PIP on same target (default: true) |PARAMETER4=
|p4= '''replace''' (Optional): [[Boolean]] - true to replace existing PIP on same target (default: true)


| [[Object]] - camera |RETURNVALUE=
| [[Object]] - camera
   
   
|x1= <code>["rendertarget0",<nowiki>[</nowiki>[heli1,heli1 selectionposition "slingload0"],cargo1],heli1,false] call BIS_fnc_PIP;</code> |Example1=
|x1= <code>["rendertarget0",<nowiki>[</nowiki>[heli1,heli1 selectionposition "slingload0"],cargo1],heli1,false] call BIS_fnc_PIP;</code>


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


| |SEEALSO=
|


}}
}}

Revision as of 23:23, 17 January 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 - 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 (Optional): Object - helicopter to which action is added (to memory point "action_screen1")
replace (Optional): Boolean - true to replace existing PIP on same target (default: true)
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:
See also needed

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