ppEffectDestroy: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Arma[ _]2(\|.*)\]\]" to "{{GameCategory|arma2|Scripting Commands}}")
m (Some wiki formatting)
 
(34 intermediate revisions by 2 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


|gr1= Camera Control |GROUP1=
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| Destroy [[Post process effects]] given by handle or array of handles. |DESCRIPTION=
|game4= arma3
____________________________________________________________________________________________
|version4= 0.50


| '''ppEffectDestroy''' effect |SYNTAX=
|gr1= Camera Control


|p1= effect: [[Number]] - effect handle |PARAMETER1=
|descr= Destroy [[Post Process Effects]] given by handle or array of handles.


|p2= |PARAMETER2=  
|s1= [[ppEffectDestroy]] effect


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


| [[Nothing]] |RETURNVALUE=
|r1= [[Nothing]]


|s2= '''ppEffectDestroy''' [effect1,...] |SYNTAX2=
|s2= [[ppEffectDestroy]] effects


|p21= [effect1,...]: [[Array]] - array of effect handles -  |PARAMETER21=
|p21= effects: [[Array]] of [[Number]]s - array of effect handles


|p22= effect1: [[Number]] - effect handle|PARAMETER22=
|r2= [[Nothing]]


|p23= |PARAMETER23=  
|x1= <sqf>ppEffectDestroy _hndl;</sqf>


| r2= [[Nothing]] |RETURNVALUE2=
|x2= <sqf>ppEffectDestroy [_hndl0, _hndl1, _hndl2];</sqf>


 
|seealso= [[Post Process Effects]] [[ppEffectForceInNVG]] [[ppEffectEnable]] [[ppEffectEnabled]] [[ppEffectCreate]] [[ppEffectCommit]] [[ppEffectCommitted]] [[ppEffectAdjust]]
|x1= <code>[[ppEffectDestroy]] _hndl;</code>|EXAMPLE1=
 
|x2= <code>[[ppEffectDestroy]] [_hndl0, _hndl1, _hndl2];</code>|EXAMPLE2=
 
____________________________________________________________________________________________
 
| [[Post process effects]], [[ppEffectForceInNVG]], [[ppEffectEnable]], [[ppEffectEnabled]], [[ppEffectCreate]], [[ppEffectCommit]], [[ppEffectCommitted]], [[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>
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 21:26, 4 September 2022

Hover & click on the images for description

Description

Description:
Destroy Post Process Effects given by handle or array of handles.
Groups:
Camera Control

Syntax

Syntax:
ppEffectDestroy effect
Parameters:
effect: Number - effect handle
Return Value:
Nothing

Alternative Syntax

Syntax:
ppEffectDestroy effects
Parameters:
effects: Array of Numbers - array of effect handles
Return Value:
Nothing

Examples

Example 1:
ppEffectDestroy _hndl;
Example 2:
ppEffectDestroy [_hndl0, _hndl1, _hndl2];

Additional Information

See also:
Post Process Effects ppEffectForceInNVG ppEffectEnable ppEffectEnabled 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