BIS fnc liveFeed: 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 - " \|seealso *= *([^ ]*)\[\[BIS fnc ([a-zA-Z0-9_]+)\]\]([^ ]*)" to " |seealso= $1BIS_fnc_$2$3")
 
(25 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|Comments=
{{RV|type=function


| arma3 |Game name=
|game1= arma3
|version1= 1.00


|1.00|Game version=
|gr1= Live Feed


|gr1= Live Feed |GROUP1=
|descr= Display a live feed.


| Display a live feed.
|s1= [source, target, receiver, effect] call [[BIS_fnc_liveFeed]]
<code>{{cc|Live feed display:}}
[[private]] _UAVFeedDisplay {{=}} [[uiNamespace]] [[getVariable]] "BIS_fnc_PIP_RscPIP";</code> |DESCRIPTION=


| [source, target, receiver, effect] call [[BIS_fnc_liveFeed]] |SYNTAX=
|p1= source: [[Object]] or [[Position]] - live feed source


|p1= source: [[Object]] or [[Position]] - live feed source |PARAMETER1=
|p2= target: [[Object]] or [[Position]] - live feed target


|p2= target: [[Object]] or [[Position]] - live feed target |PARAMETER2=
|p3= receiver: [[Object]] - player that will see the feed - if not [[Multiplayer Scripting#Locality|local]], function will do nothing
 
|p3= receiver: [[Object]] - player that will see the feed - if not [[local]], function will do nothing |PARAMETER3=


|p4= effect: [[Number]] - (Optional, default 0)  live feed effect. Can be one of:
|p4= effect: [[Number]] - (Optional, default 0)  live feed effect. Can be one of:
Line 23: Line 20:
* &nbsp;0: normal
* &nbsp;0: normal
* &nbsp;1: night vision
* &nbsp;1: night vision
* &nbsp;2: thermal imaging |PARAMETER4=
* &nbsp;2: thermal imaging


| [[Boolean]] - [[true]] if successful, [[false]] if not |RETURNVALUE=
|r1= [[Boolean]] - [[true]] if successful, [[false]] if not


|x1= <code>[myUAV, [[player]], [[player]], 2] [[call]] [[BIS_fnc_liveFeed]];</code> |EXAMPLE1=
|x1= <sqf>[myUAV, player, player, 2] call BIS_fnc_liveFeed;</sqf>


| [[BIS fnc liveFeedEffects]], [[BIS fnc liveFeedSetSource]], [[BIS fnc liveFeedSetTarget]], [[BIS fnc liveFeedTerminate]] |SEEALSO=
|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">Bottom Section</h3>

Latest revision as of 18:02, 13 July 2022

Arma 3 logo black.png1.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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_liveFeed&oldid=328590"