ppEffectCommit: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Take[ _]On[ _]Helicopters(\|.*)?\]\]" to "{{GameCategory|tkoh|Scripting Commands}}")
m (Text replacement - "[[Post process effects" to "[[Post Process Effects")
 
(32 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


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


| Commit [[Post process effects|post process effect]] in given time. |DESCRIPTION=
|game4= arma3
____________________________________________________________________________________________
|version4= 0.50


| effect '''ppEffectCommit''' commit |SYNTAX=
|gr1= Camera Control


|p1= effect: [[String]] - name of the effect |PARAMETER1=
|descr= Commit [[Post Process Effects|post process effect]] in given time.


|p2= commit: [[Number]] - duration |PARAMETER2=
|s1= effect [[ppEffectCommit]] commit


|p3= |PARAMETER3=  
|p1= effect: [[String]] - name of the effect


| [[Nothing]] |RETURNVALUE=
|p2= commit: [[Number]] - duration


| s2= handle '''ppEffectCommit''' commit |SYNTAX2=
|r1= [[Nothing]]


|p21= handle: [[Number]] - handle of the effect |PARAMETER21=
|s2= handle [[ppEffectCommit]] commit


|p22= commit: [[Number]] - duration |PARAMETER22=
|p21= handle: [[Number]] - handle of the effect


|p23= |PARAMETER23=  
|p22= commit: [[Number]] - duration


|r2= [[Nothing]] |RETURNVALUE2=
|r2= [[Nothing]]


|s3= handles '''ppEffectCommit''' commit |SYNTAX3=
|s3= handles [[ppEffectCommit]] commit


|p42= handles: [[Array]] of [[Number]]s - list of handles |PARAMETER42=
|p41= handles: [[Array]] of [[Number]]s - list of handles


|p43= commit: [[Number]] - duration |PARAMETER43=
|p42= commit: [[Number]] - duration


|r3= [[Nothing]] |RETURNVALUE3=
|r3= [[Nothing]]


|x1= <code>"colorCorrection" [[ppEffectCommit]] 3;</code>|EXAMPLE1=
|x1= <sqf>"colorCorrection" ppEffectCommit 3;</sqf>


|x2= <code>_hndl [[ppEffectCommit]] 3;</code>|EXAMPLE2=
|x2= <sqf>_hndl ppEffectCommit 3;</sqf>


|x3= <code>[_hndl1, _hndl2] [[ppEffectCommit]] 3;</code>|EXAMPLE3=
|x3= <sqf>[_hndl1, _hndl2] ppEffectCommit 3;</sqf>


____________________________________________________________________________________________
|seealso= [[Post Process Effects]] [[ppEffectForceInNVG]] [[ppEffectEnable]] [[ppEffectEnabled]] [[ppEffectDestroy]] [[ppEffectCreate]] [[ppEffectCommitted]] [[ppEffectAdjust]]
 
| [[Post process effects]], [[ppEffectForceInNVG]], [[ppEffectEnable]], [[ppEffectEnabled]], [[ppEffectDestroy]], [[ppEffectCreate]], [[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|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}

Latest revision as of 23:25, 12 July 2022

Hover & click on the images for description

Description

Description:
Commit post process effect in given time.
Groups:
Camera Control

Syntax 1

Syntax:
effect ppEffectCommit commit
Parameters:
effect: String - name of the effect
commit: Number - duration
Return Value:
Nothing

Syntax 2

Syntax:
handle ppEffectCommit commit
Parameters:
handle: Number - handle of the effect
commit: Number - duration
Return Value:
Nothing

Syntax 3

Syntax:
handles ppEffectCommit commit
Parameters:
handles: Array of Numbers - list of handles
commit: Number - duration
Return Value:
Nothing

Examples

Example 1:
"colorCorrection" ppEffectCommit 3;
Example 2:
_hndl ppEffectCommit 3;
Example 3:
[_hndl1, _hndl2] ppEffectCommit 3;

Additional Information

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