ppEffectEnable: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Arma[ _]3(\|.*)\]\]" to "{{GameCategory|arma3|Scripting Commands}}") |
Lou Montana (talk | contribs) m (Some wiki formatting) |
||
| (35 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
{{ | {{RV|type=command | ||
| arma2 | | |game1= arma2 | ||
|version1= 1.00 | |||
|1. | |game2= arma2oa | ||
|version2= 1.50 | |||
| | |game3= tkoh | ||
|version3= 1.00 | |||
| | |game4= arma3 | ||
|version4= 0.50 | |||
| | |gr1= Camera Control | ||
| | |descr= Enable / disable [[Post Process Effects]] | ||
{{Feature | important | If effect fails to get enabled (can check it with [[ppEffectEnabled]]) try adding a little [[sleep]] in front of it. }} | |||
| | |s1= effect [[ppEffectEnable]] enable | ||
| [[ | |p1= effect: [[String]] - name of the effect | ||
| | |p2= enable: [[Boolean]] | ||
| | |r1= [[Nothing]] | ||
| | |s2= effect [[ppEffectEnable]] enable | ||
| | |p21= effect: [[Number]] - handle of the effect | ||
| | |p22= enable: [[Boolean]] | ||
| | |r2= [[Nothing]] | ||
| | |s3= effectArray [[ppEffectEnable]] enable | ||
| | |p41= effectArray: [[Array]] of [[Number]]s - array of effect handles | ||
| | |p42= enable: [[Boolean]] | ||
| | |r3= [[Nothing]] | ||
| | |x1= <sqf>"colorCorrections" ppEffectEnable true;</sqf> | ||
| | |x2= <sqf>_hndl ppEffectEnable true;</sqf> | ||
| | | |x3= <sqf>[_hndl1, _hndl2] ppEffectEnable true;</sqf> | ||
|seealso= [[Post Process Effects]] [[ppEffectForceInNVG]] [[ppEffectDestroy]] [[ppEffectCreate]] [[ppEffectEnabled]] [[ppEffectCommit]] [[ppEffectCommitted]] [[ppEffectAdjust]] | |||
}} | }} | ||
{{Note | |||
|user= Pi123263 | |||
|timestamp= 20240406133257 | |||
|text= Using ppEffectEnable immediatelly enables/disables the effect. If you want the effect to fade in/out it might be better to use ppEffectAdjust. | |||
< | If you want to fade out an effect using ppEffectAdjust you can set the values for the command back to the default and then use ppEffectCommit to set the time for the fadeout. | ||
< | <br> | ||
Example: | |||
< | Activate effect: | ||
<sqf> | |||
[[ | "colorCorrections" ppEffectAdjust [1,1,0,[0,0,0,0],[0,0,0,0.24],[1,1,1,0],[0.6,0.5,0,0,-0.1,0.4,0.8]]; | ||
[[ | "colorCorrections" ppEffectEnable true; | ||
"colorCorrections" ppEffectCommit 0; | |||
</sqf> | |||
And then fade the effect out over 10 seconds: | |||
<sqf> | |||
"colorCorrections" ppEffectAdjust [1,1,0,[0,0,0,0],[1,1,1,1],[0.299, 0.587, 0.114, 0],[-1,-1,0,0,0,0,0]]; | |||
"colorCorrections" ppEffectCommit 10; | |||
</sqf> | |||
}} | |||
Latest revision as of 10:27, 7 April 2024
Description
- Description:
- Enable / disable Post Process Effects
- Groups:
- Camera Control
Syntax 1
- Syntax:
- effect ppEffectEnable enable
- Parameters:
- effect: String - name of the effect
- enable: Boolean
- Return Value:
- Nothing
Syntax 2
- Syntax:
- effect ppEffectEnable enable
- Parameters:
- effect: Number - handle of the effect
- enable: Boolean
- Return Value:
- Nothing
Syntax 3
- Syntax:
- effectArray ppEffectEnable enable
- Parameters:
- effectArray: Array of Numbers - array of effect handles
- enable: Boolean
- Return Value:
- Nothing
Examples
- Example 1:
- Example 2:
- Example 3:
Additional Information
- See also:
- Post Process Effects ppEffectForceInNVG ppEffectDestroy ppEffectCreate ppEffectEnabled 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
- Posted on Apr 06, 2024 - 13:32 (UTC)
-
Using ppEffectEnable immediatelly enables/disables the effect. If you want the effect to fade in/out it might be better to use ppEffectAdjust.
If you want to fade out an effect using ppEffectAdjust you can set the values for the command back to the default and then use ppEffectCommit to set the time for the fadeout.
Example: Activate effect:And then fade the effect out over 10 seconds:"colorCorrections" ppEffectAdjust [1,1,0,[0,0,0,0],[0,0,0,0.24],[1,1,1,0],[0.6,0.5,0,0,-0.1,0.4,0.8]]; "colorCorrections" ppEffectEnable true; "colorCorrections" ppEffectCommit 0;"colorCorrections" ppEffectAdjust [1,1,0,[0,0,0,0],[1,1,1,1],[0.299, 0.587, 0.114, 0],[-1,-1,0,0,0,0,0]]; "colorCorrections" ppEffectCommit 10;