ppEffectEnable

1.001.501.000.50

Hover & click on the images for description

Description

Description:

Enable / disable Post Process Effects

⚠

If effect fails to get enabled (can check it with ppEffectEnabled) try adding a little sleep in front of it.

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:

"colorCorrections" ppEffectEnable true;

Example 2:

_hndl ppEffectEnable true;

Example 3:

[_hndl1, _hndl2] ppEffectEnable true;

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

Pi123263 - c

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:

"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;

And then fade the effect out over 10 seconds:

"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;