ppEffectAdjust: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " \| ?r2=(.*)\|RETURNVALUE= *" to " |r2=(.*)|RETURNVALUE2=")
m (Fix bad regex effects)
Tag: Undo
Line 6: Line 6:
|1.00|Game version=
|1.00|Game version=


|eff = local|=
|eff = local |MP Effects=
____________________________________________________________________________________________
____________________________________________________________________________________________


| Set [[Post process effects|post process effect]] parameters. <br><br>'''NOTE:''' The two syntaxes differ in what format of the params they accept. The syntax with PP name expects colors to be packed into arrays within main array, while the syntax with PP handle can handle both flat and packed array. Therefore it is recommended to use the universal packed format, such as shown in the examples. |DESCRIPTION=
| Set [[Post process effects|post process effect]] parameters.
 
{{Informative | The two syntaxes differ in what format of the params they accept. The syntax with PP name expects colors to be packed into arrays within main array, while the syntax with PP handle can handle both flat and packed array. Therefore it is recommended to use the universal packed format, such as shown in the examples.}} |DESCRIPTION=
____________________________________________________________________________________________
____________________________________________________________________________________________


Line 17: Line 19:


|p2= settings: [[Array]] - array of effect params |PARAMETER2=  
|p2= settings: [[Array]] - array of effect params |PARAMETER2=  
|p3= |PARAMETER3=


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


| s2= effect '''ppEffectAdjust''' settings |SYNTAX2=
| s2= handle '''ppEffectAdjust''' settings |SYNTAX2=
 
|p21= effect: [[Number]] - effect handle |PARAMETER21=
 
|p22= settings: [[Array]] - array of effect params |PARAMETER2=  


|p23= |PARAMETER3=  
|p21= handle: [[Number]] - effect handle |PARAMETER21=


|r2=(.*)|RETURNVALUE2=  
|p22= settings: [[Array]] - array of effect params |PARAMETER22=  


|r2= [[Nothing]] |RETURNVALUE2=


|x1= <code>"colorCorrections" [[ppEffectAdjust]] [1, 1, -0.01, [0, 0, 0, 0], [1.5, 1, 1.2, 0.6], [0.199, 0.587, 0.114, 0]];</code>|EXAMPLE1=  
|x1= <code>"colorCorrections" [[ppEffectAdjust]] [1, 1, -0.01, [0, 0, 0, 0], [1.5, 1, 1.2, 0.6], [0.199, 0.587, 0.114, 0]];</code>|EXAMPLE1=  
|x2=|EXAMPLE2=


|x2= Black&White: <code>_colorCorrectionsEffHandle [[ppEffectAdjust]] [1, 0.4, 0, [0, 0, 0, 0], [1, 1, 1, 0], [1, 1, 1, 0]];</code>|EXAMPLE2=
____________________________________________________________________________________________
____________________________________________________________________________________________


Line 53: Line 50:
<h3 style='display:none'>Bottom Section</h3>
<h3 style='display:none'>Bottom Section</h3>


[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Revision as of 22:06, 24 September 2020

Hover & click on the images for description

Description

Description:
Set post process effect parameters.
The two syntaxes differ in what format of the params they accept. The syntax with PP name expects colors to be packed into arrays within main array, while the syntax with PP handle can handle both flat and packed array. Therefore it is recommended to use the universal packed format, such as shown in the examples.
Groups:
Uncategorised

Syntax

Syntax:
effect ppEffectAdjust settings
Parameters:
effect: String effect name
settings: Array - array of effect params
Return Value:
Nothing

Alternative Syntax

Syntax:
handle ppEffectAdjust settings
Parameters:
handle: Number - effect handle
settings: Array - array of effect params
Return Value:
Nothing

Examples

Example 1:
"colorCorrections" ppEffectAdjust [1, 1, -0.01, [0, 0, 0, 0], [1.5, 1, 1.2, 0.6], [0.199, 0.587, 0.114, 0]];
Example 2:
Black&White: _colorCorrectionsEffHandle ppEffectAdjust [1, 0.4, 0, [0, 0, 0, 0], [1, 1, 1, 0], [1, 1, 1, 0]];

Additional Information

See also:
Post process effectsppEffectForceInNVGppEffectEnableppEffectEnabledppEffectDestroyppEffectCreateppEffectCommittedppEffectCommitsetPiPEffect

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