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: @@
+{{RV|type=function
-{{Function|= Comments
+|game1= arma3
-____________________________________________________________________________________________
+|version1= 1.00
-| arma3 |= Game name
+|gr1= Live Feed
-|1.00|= Game version
+|descr= Display a live feed.
-____________________________________________________________________________________________
-| <pre>/*
+|s1= [source, target, receiver, effect] call [[BIS_fnc_liveFeed]]
-	Description:
-	Display a live feed.
-	Parameters:
-		_this select 0: OBJECT or ARRAY - Live feed source
-		_this select 1: OBJECT or ARRAY - Live feed target
-		_this select 2: OBJECT - Player that will see the feed
-		_this select 3 (Optional): NUMBER - Live feed effects (-1: reset, 0: normal (default), 1: night vision, 2: thermal imaging)
-	Returns:
-	True if successful, false if not.
-*/
-// Doesn't need to be run on a dedicated server
+|p1= source: [[Object]] or [[Position]] - live feed source
-</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
-____________________________________________________________________________________________
-| <!-- [] call [[BIS_fnc_liveFeed]]; --> |= Syntax
+|p2= target: [[Object]] or [[Position]] - live feed target
-|p1= |= Parameter 1
+|p3= receiver: [[Object]] - player that will see the feed - if not [[Multiplayer Scripting#Locality|local]], function will do nothing
-| |= Return value
+|p4= effect: [[Number]] - (Optional, default 0)  live feed effect. Can be one of:
-____________________________________________________________________________________________
+* -1: reset
+* &nbsp;0: normal
+* &nbsp;1: night vision
+* &nbsp;2: thermal imaging
-|x1= <code></code> |=
+|r1= [[Boolean]] - [[true]] if successful, [[false]] if not
-____________________________________________________________________________________________
-| |= See also
+|x1= <sqf>[myUAV, player, player, 2] call BIS_fnc_liveFeed;</sqf>
+|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}}]]