ppEffectEnable: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (template:command argument fix)
Line 12: Line 12:
| effect '''ppEffectEnable''' enable |= Syntax
| effect '''ppEffectEnable''' enable |= Syntax


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


|p2= enable: [[Boolean]] |= PARAMETER2
|p2= enable: [[Boolean]] |PARAMETER2=  


|p3= |= PARAMETER3
|p3= |PARAMETER3=  


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


| s2= effect '''ppEffectEnable''' enable |= Syntax
| s2= effect '''ppEffectEnable''' enable |= Syntax


|p21= effect: [[Number]] - handle of the effect |= PARAMETER1
|p21= effect: [[Number]] - handle of the effect |PARAMETER1=  


|p22= enable: [[Boolean]] |= PARAMETER2
|p22= enable: [[Boolean]] |PARAMETER2=  


|p23= |= PARAMETER3
|p23= |PARAMETER3=  


| r2= [[Nothing]] |= RETURNVALUE
| r2= [[Nothing]] |RETURNVALUE=


| s3= [effect1,...] '''ppEffectEnable''' enable |= Syntax
| s3= [effect1,...] '''ppEffectEnable''' enable |= Syntax


|p41= [effect1,...]: [[Array]] - array of effect handles |= PARAMETER1
|p41= [effect1,...]: [[Array]] - array of effect handles |PARAMETER1=  


|p42= effect1: [[Number]] - handle of the effect |= PARAMETER2
|p42= effect1: [[Number]] - handle of the effect |PARAMETER2=  


|p43= enable: [[Boolean]] |= PARAMETER3
|p43= enable: [[Boolean]] |PARAMETER3=  


| r3= [[Nothing]] |= RETURNVALUE
| r3= [[Nothing]] |RETURNVALUE=




|x1= <code>"colorCorrections" [[ppEffectEnable]] [[true]];</code>|= EXAMPLE1
|x1= <code>"colorCorrections" [[ppEffectEnable]] [[true]];</code>|EXAMPLE1=  
|x2= <code>_hndl [[ppEffectEnable]] [[true]];</code>|= EXAMPLE1
|x2= <code>_hndl [[ppEffectEnable]] [[true]];</code>|EXAMPLE1=  
|x3= <code>[_hndl1, _hndl2] [[ppEffectEnable]] [[true]];</code>|= EXAMPLE1
|x3= <code>[_hndl1, _hndl2] [[ppEffectEnable]] [[true]];</code>|EXAMPLE1=  


____________________________________________________________________________________________
____________________________________________________________________________________________


| [[Post process effects]], [[ppEffectForceInNVG]], [[ppEffectDestroy]], [[ppEffectCreate]], [[ppEffectEnabled]], [[ppEffectCommit]], [[ppEffectCommitted]], [[ppEffectAdjust]] |= SEEALSO
| [[Post process effects]], [[ppEffectForceInNVG]], [[ppEffectDestroy]], [[ppEffectCreate]], [[ppEffectEnabled]], [[ppEffectCommit]], [[ppEffectCommitted]], [[ppEffectAdjust]] |SEEALSO=  


|  |= MPBEHAVIOUR
|  |MPBEHAVIOUR=  
____________________________________________________________________________________________
____________________________________________________________________________________________
}}
}}

Revision as of 11:35, 7 April 2019

Hover & click on the images for description

Description

Description:
Enable / disable Post process effects
Groups:
Uncategorised

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:
[effect1,...] ppEffectEnable enable
Parameters:
[effect1,...]: Array - array of effect handles
effect1: Number - handle of the effect
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 effectsppEffectForceInNVGppEffectDestroyppEffectCreateppEffectEnabledppEffectCommitppEffectCommittedppEffectAdjust

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

Notes

Bottom Section