ppEffectEnabled: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame( +[0-9])?|Game [Vv]ersion( +[0-9])?|Game Version \(number surrounded by NO SPACES\)|Arguments in MP|MP[Aa]rg|Multiplayer Arguments( \("local" or "global"\))?|Effects|Execution|Effects...)
m (Text replacement - "Post process effects" to "Post Process Effects")
 
(19 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command
{{RV|type=command


|arma3
|game1= arma3
 
|version1= 1.56
|1.56


|gr1= Camera Control
|gr1= Camera Control


| Checks whether given post process effect is enabled
|descr= Checks whether given post process effect is enabled


| '''ppEffectEnabled''' effect
|s1= [[ppEffectEnabled]] effect


|p1= effect: [[Number]] - effect handle
|p1= effect: [[Number]] - effect handle


| [[Boolean]]
|r1= [[Boolean]]


|x1= <code>_enabled = [[ppEffectEnabled]] _hndl;</code>
|s2= [[ppEffectEnabled]] effect


|s2since= arma3 2.04


| [[Post process effects]], [[ppEffectForceInNVG]], [[ppEffectDestroy]], [[ppEffectEnable]], [[ppEffectCreate]], [[ppEffectCommit]], [[ppEffectCommitted]], [[ppEffectAdjust]]
|p21= effect: [[String]] - effect name


|
|r2= [[Boolean]]
}}


|x1= <sqf>_enabled = ppEffectEnabled _hndl;</sqf>
|x2= <sqf>_enabled = ppEffectEnabled "DynamicBlur";</sqf>


{{GameCategory|arma3|New Scripting Commands}}
|seealso= [[Post Process Effects]] [[ppEffectForceInNVG]] [[ppEffectDestroy]] [[ppEffectEnable]] [[ppEffectCreate]] [[ppEffectCommit]] [[ppEffectCommitted]] [[ppEffectAdjust]]
{{GameCategory|arma3|Scripting Commands}}
}}
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 23:24, 12 July 2022

Hover & click on the images for description

Description

Description:
Checks whether given post process effect is enabled
Groups:
Camera Control

Syntax

Syntax:
ppEffectEnabled effect
Parameters:
effect: Number - effect handle
Return Value:
Boolean

Alternative Syntax

Syntax:
ppEffectEnabled effect
Parameters:
effect: String - effect name
Return Value:
Boolean

Examples

Example 1:
_enabled = ppEffectEnabled _hndl;
Example 2:
_enabled = ppEffectEnabled "DynamicBlur";

Additional Information

See also:
Post Process Effects ppEffectForceInNVG ppEffectDestroy ppEffectEnable ppEffectCreate ppEffectCommit ppEffectCommitted ppEffectAdjust

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