BIS fnc PIP: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Created page with "{{Function|= Comments ____________________________________________________________________________________________ | TKOH |= Game name |1.00|= Game version ____________________...")
Line 1: Line 1:
{{Function|= Comments
{{Function|= Comments
____________________________________________________________________________________________
____________________________________________________________________________________________


| tkoh |= Game name
| TKOH |= Game name


|1.00|= Game version
|1.00|= Game version
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>/*
| Displays Picture in Picture. |= Description
 
Description:
Displays Picture in Picture
When empty array [] is passed as argument, current camera is terminated
 
Parameter(s):
_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:
OBJECT - camera
*/
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_PIP]]; --> |= Syntax
| [renderTarget, cameraParams, (vehicle, replace)] call bis_fnc_PIP; |= Syntax


|p1= |= Parameter 1
|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") |=
|p4= '''vehicle''' (Optional): [[Boolean]] - true to replace existing PIP on same target (default: true) |=


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


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


Line 48: Line 41:


<h3 style="display:none">Bottom Section</h3>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: GUI|{{uc:PIP}}]]
 
[[Category:Functions|{{uc:PIP}}]]
[[Category:Take_On_Helicopters:_Functions|pip]]
[[Category:{{Name|tkoh}}: Functions|{{uc:PIP}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:PIP}}]]

Revision as of 10:32, 21 October 2011

Hover & click on the images for description

Description

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

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")
vehicle (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

Notes

Bottom Section