BIS fnc liveFeedEffects: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Text replacement - "(\|p[0-9]+ *= *[^(]+\(Optional(, default[^)]*)\) )L([a-z])" to "$1l$3")
 
(29 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
____________________________________________________________________________________________


| Add effect to the current live feed. |DESCRIPTION=
|descr= Add effect to the current live feed.
____________________________________________________________________________________________


| effect call [[BIS_fnc_liveFeedEffects]] |SYNTAX=
|s1= effect call [[BIS_fnc_liveFeedEffects]]


|p1= effect: [[Number]] - (Optional, default 0) Live feed effect. Can be one of:
|p1= effect: [[Number]] - (Optional, default 0) live feed effect. Can be one of:
* -1: reset
* -1: reset
*  0: normal
*  0: normal
*  1: night vision
*  1: night vision
*  2: thermal imaging |PARAMETER1=
*  2: thermal imaging


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


|x1= <code>1 [[call]] [[BIS_fnc_liveFeedEffects]];</code> |EXAMPLE1=
|x1= <sqf>1 call BIS_fnc_liveFeedEffects;</sqf>
____________________________________________________________________________________________


| [[BIS fnc liveFeed]], [[BIS fnc liveFeedSetSource]], [[BIS fnc liveFeedSetTarget]], [[BIS fnc liveFeedTerminate]] |SEEALSO=
|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}}]]

Latest revision as of 12:30, 8 November 2023

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