ppEffectCommitted: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(alt syntax)
m (Text replacement - "(\|[pr][0-9]+ *= *[^-]+) *- *E([a-z])" to "$1 - e$2")
 
(44 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma2 |= Game name
|game1= arma2
|version1= 1.00


|1.00|= Game version
|game2= arma2oa
____________________________________________________________________________________________
|version2= 1.50


| Check whether given [[Post process effects|post process effect]] is committed |= Description
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| '''ppEffectCommitted''' effect |= Syntax
|game4= arma3
|version4= 0.50


|p1= effect: [[String]] - effect name |= PARAMETER1
|gr1= Camera Control


|p2= |= PARAMETER2
|descr= Check whether given [[Post Process Effects|post process effect]] is committed.


|p3= |= PARAMETER3
|s1= [[ppEffectCommitted]] effect


| [[Boolean]] |= RETURNVALUE
|p1= effect: [[String]] - effect name


| s2='''ppEffectCommitted''' effect |= Syntax
|r1= [[Boolean]]


|p21= effect: [[Number]] - effect handle |= PARAMETER1
|s2= [[ppEffectCommitted]] handle


|p22= |= PARAMETER2
|p21= handle: [[Number]] - effect handle


|p23= |= PARAMETER3
|r2= [[Boolean]]


| r2= [[Boolean]] |= RETURNVALUE
|x1= <sqf>ppEffectCommitted "colorCorrection";</sqf>


|x1= <code>[[ppEffectCommitted]] "colorCorrection";</code>|= EXAMPLE1
|x2= <sqf>ppEffectCommitted _hndl;</sqf>
|x2= <code>[[ppEffectCommitted]] _hndl;</code>|= EXAMPLE1


|x3= <code>[[if]] ([[ppEffectCommitted]] "colorCorrection") [[then]] {[[hint]] "alteration done !"};</code>|= EXAMPLE1
|x3= <sqf>if (ppEffectCommitted "colorCorrection") then { hint "alteration done !" };</sqf>


____________________________________________________________________________________________
|seealso= [[Post Process Effects]] [[ppEffectForceInNVG]] [[ppEffectEnable]] [[ppEffectDestroy]] [[ppEffectCreate]] [[ppEffectCommit]] [[ppEffectAdjust]]
 
| [[Post process effects]], [[ppEffectForceInNVG]], [[ppEffectEnable]], [[ppEffectDestroy]], [[ppEffectCreate]], [[ppEffectCommit]], [[ppEffectAdjust]] |= SEEALSO
 
|  |= MPBEHAVIOUR
____________________________________________________________________________________________
}}
}}
<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:ArmA 2: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 14:06, 8 November 2023

Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
Hover & click on the images for description

Description

Description:
Check whether given post process effect is committed.
Groups:
Camera Control

Syntax

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

Alternative Syntax

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

Examples

Example 1:
ppEffectCommitted "colorCorrection";
Example 2:
ppEffectCommitted _hndl;
Example 3:
if (ppEffectCommitted "colorCorrection") then { hint "alteration done !" };

Additional Information

See also:
Post Process Effects ppEffectForceInNVG ppEffectEnable ppEffectDestroy ppEffectCreate ppEffectCommit 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
Retrieved from "https://community.bistudio.com/wiki?title=ppEffectCommitted&oldid=348518"