BIS fnc liveFeedEffects: Difference between revisions

Latest revision as of 12:30, 8 November 2023

1.00

Hover & click on the images for description

Description

Description:: Add effect to the current live feed.
Execution:: call
Groups:: Live Feed

Syntax

Syntax:

effect call BIS_fnc_liveFeedEffects

Parameters:

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:: 1 call BIS_fnc_liveFeedEffects;

Additional Information

See also:: BIS_fnc_liveFeed 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= Add effect to the current live feed.
-____________________________________________________________________________________________
-| <pre>/*
+|s1= effect call [[BIS_fnc_liveFeedEffects]]
-	Description:
-	Add effects to a live feed.
-	Parameters:
-		_this (Optional): NUMBER - Live feed effects (-1: reset, 0: normal (default), 1: night vision, 2: thermal imaging)
-	Returns:
-	True if successful, false if not.
-*/
-</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
+|p1= 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
-| <!-- [] call [[BIS_fnc_liveFeedEffects]]; --> |= Syntax
+|r1= [[Boolean]] - [[true]] if successful, [[false]] if not
-|p1= |= Parameter 1
+|x1= <sqf>1 call BIS_fnc_liveFeedEffects;</sqf>
-| |= Return value
-____________________________________________________________________________________________
-|x1= <code></code> |=
-____________________________________________________________________________________________
-| |= See also
+|seealso=     [[BIS_fnc_liveFeed]] [[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:liveFeedEffects}}]]
-[[Category:Functions|{{uc:liveFeedEffects}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:liveFeedEffects}}]]