ppEffectEnabled: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\{\{GameCategory\|(arma[0123])\|[ _]?New[ _]Scripting[ _]Commands[ _]List\}\}" to "{{GameCategory|$1|New Scripting Commands}}")
m (Text replacement - "Post process effects" to "Post Process Effects")
 
(23 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


|arma3|Game name=
|game1= arma3
|version1= 1.56


|1.56|Game version=
|gr1= Camera Control


|gr1= Camera Control |GROUP1=
|descr= Checks whether given post process effect is enabled
____________________________________________________________________________________________


| Checks whether given post process effect is enabled |DESCRIPTION=
|s1= [[ppEffectEnabled]] effect
____________________________________________________________________________________________


| '''ppEffectEnabled''' effect |SYNTAX=
|p1= effect: [[Number]] - effect handle


|p1= effect: [[Number]] - effect handle |PARAMETER1=
|r1= [[Boolean]]


| [[Boolean]] |RETURNVALUE=
|s2= [[ppEffectEnabled]] effect


|x1= <code>_enabled = [[ppEffectEnabled]] _hndl;</code>|EXAMPLE1=  
|s2since= arma3 2.04


____________________________________________________________________________________________
|p21= effect: [[String]] - effect name


| [[Post process effects]], [[ppEffectForceInNVG]], [[ppEffectDestroy]], [[ppEffectEnable]], [[ppEffectCreate]], [[ppEffectCommit]], [[ppEffectCommitted]], [[ppEffectAdjust]] |SEEALSO=
|r2= [[Boolean]]


| |MPBEHAVIOUR=  
|x1= <sqf>_enabled = ppEffectEnabled _hndl;</sqf>
____________________________________________________________________________________________
|x2= <sqf>_enabled = ppEffectEnabled "DynamicBlur";</sqf>
 
|seealso= [[Post Process Effects]] [[ppEffectForceInNVG]] [[ppEffectDestroy]] [[ppEffectEnable]] [[ppEffectCreate]] [[ppEffectCommit]] [[ppEffectCommitted]] [[ppEffectAdjust]]
}}
}}
<h3 style='display:none'>Notes</h3>
<dl class='command_description'>
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style='display:none'>Bottom Section</h3>
{{GameCategory|arma3|New Scripting Commands}}
{{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