BIS fnc liveFeed: Difference between revisions

Latest revision as of 18:02, 13 July 2022

1.00

Hover & click on the images for description

Description

Description:: Display a live feed.
Execution:: call
Groups:: Live Feed

Syntax

Syntax:

[source, target, receiver, effect] call BIS_fnc_liveFeed

Parameters:

source: Object or Position - live feed source

target: Object or Position - live feed target

receiver: Object - player that will see the feed - if not local, function will do nothing

effect: Number - (Optional, default 0) live feed effect. Can be one of:

-1: reset
0: normal
1: night vision
2: thermal imaging

Return Value:

Boolean - true if successful, false if not

Examples

Example 1:: [myUAV, player, player, 2] call BIS_fnc_liveFeed;
Example 2:: live feed display:
private _UAVFeedDisplay = uiNamespace getVariable "BIS_fnc_PIP_RscPIP";

Additional Information

See also:: BIS_fnc_liveFeedEffects BIS_fnc_liveFeedSetSource BIS_fnc_liveFeedSetTarget BIS_fnc_liveFeedTerminate

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
-____________________________________________________________________________________________
-| arma3 |= Game name
+|game1= arma3
+|version1= 1.00
-|1.00|= Game version
+|gr1= Live Feed
-____________________________________________________________________________________________
-| Display a live feed. |= Description
+|descr= Display a live feed.
-____________________________________________________________________________________________
-| [source, target, receiver, effect] call [[BIS_fnc_liveFeed]] |= Syntax
+|s1= [source, target, receiver, effect] call [[BIS_fnc_liveFeed]]
-|p1= source: [[Object]] or [[Position]] - live feed source |= Parameter 1
+|p1= source: [[Object]] or [[Position]] - live feed source
-|p2= target: [[Object]] or [[Position]] - live feed target |= Parameter 2
+|p2= target: [[Object]] or [[Position]] - live feed target
-|p3= receiver: [[Object]] - player that will see the feed - if not [[local]], function will do nothing |= Parameter 3
+|p3= receiver: [[Object]] - player that will see the feed - if not [[Multiplayer Scripting#Locality|local]], function will do nothing
 |p4= effect: [[Number]] - (Optional, default 0)  live feed effect. Can be one of:
@@ Line 22: / Line 20: @@
 * &nbsp;0: normal
 * &nbsp;1: night vision
-* &nbsp;2: thermal imaging |= Parameter 4
+* &nbsp;2: thermal imaging
-| [[Boolean]] - [[true]] if successful, [[false]] if not |= Return value
+|r1= [[Boolean]] - [[true]] if successful, [[false]] if not
-____________________________________________________________________________________________
-|x1= <code>[myUAV, [[player]], [[player]], 2] [[call]] [[BIS_fnc_liveFeed]];</code> |= Example 1
+|x1= <sqf>[myUAV, player, player, 2] call BIS_fnc_liveFeed;</sqf>
-____________________________________________________________________________________________
-| [[BIS fnc liveFeedEffects]], [[BIS fnc liveFeedSetSource]], [[BIS fnc liveFeedSetTarget]], [[BIS fnc liveFeedTerminate]] |= See also
+|x2= live feed display:
+<sqf>private _UAVFeedDisplay = uiNamespace getVariable "BIS_fnc_PIP_RscPIP";</sqf>
+|seealso=     [[BIS_fnc_liveFeedEffects]] [[BIS_fnc_liveFeedSetSource]] [[BIS_fnc_liveFeedSetTarget]] [[BIS_fnc_liveFeedTerminate]]
 }}
-<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:liveFeed}}]]
-[[Category:Functions|{{uc:liveFeed}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:liveFeed}}]]