ppEffectAdjust: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(B&W example, see also)
m (Text replacement - "\{\{Feature *\| *Informative *\| ([^↵]+) *\}\}" to "{{Feature|informative|$1}}")
 
(64 intermediate revisions by 6 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


|eff = local|=
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| Set [[Post process effects|post process effect]] parameters |= Description
|game4= arma3
____________________________________________________________________________________________
|version4= 0.50


| effect '''ppEffectAdjust''' settings |= Syntax
|eff= local


|p1= effect: [[String]] or [[Number]] - where string is effect name or number is ppEffect handle. |= PARAMETER1
|gr1= Camera Control


|p2= settings: [[Array]] |= PARAMETER2
|descr= Set [[Post Process Effects|post process effect]] parameters.


|p3= |= PARAMETER3
{{Feature|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.}}


| Nothing |= RETURNVALUE
|s1= effect [[ppEffectAdjust]] settings


|p1= effect: [[String]] or [[Number]]
* [[String]] - effect name
* [[Number]] - effect handle


|x1= <code>"colorCorrections" [[ppEffectAdjust]] [1,1,-0.01,[0.0,0.0,0.0,0.0],[1.5,1,1.2,0.6],[0.199,0.587,0.114,0.20]];</code>|= EXAMPLE1
|p2= settings: [[Array]] - array of effect params
|x2= Black&White: <code>_eff [[ppEffectAdjust]] [0.4,0,[0,0,0,0],[1,1,1,0],[1,1,1,1]];</code>|= EXAMPLE1


____________________________________________________________________________________________
|r1= [[Nothing]]


| [[Post process effects]], [[ppEffectForceInNVG]], [[ppEffectEnable]], [[ppEffectDestroy]], [[ppEffectCreate]], [[ppEffectCommitted]], [[ppEffectCommit]], [[setPiPEffect]]|= SEEALSO
|r2= [[Nothing]]


| |= MPBEHAVIOUR
|x1= <sqf>"colorCorrections" ppEffectAdjust [1, 1, -0.01, [0, 0, 0, 0], [1.5, 1, 1.2, 0.6], [0.199, 0.587, 0.114, 0]];</sqf>
____________________________________________________________________________________________
}}


<h3 style='display:none'>Notes</h3>
|x2= Black&White:
<dl class='command_description'>
<sqf>_colorCorrectionsEffHandle ppEffectAdjust [1, 0.4, 0, [0, 0, 0, 0], [1, 1, 1, 0], [1, 1, 1, 0]];</sqf>
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|seealso= [[Post Process Effects]] [[ppEffectForceInNVG]] [[ppEffectEnable]] [[ppEffectEnabled]] [[ppEffectDestroy]] [[ppEffectCreate]] [[ppEffectCommitted]] [[ppEffectCommit]] [[setPiPEffect]]
</dl>
}}
 
<h3 style='display:none'>Bottom Section</h3>
[[Category:ArmA 2: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 18:11, 15 March 2024

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:
Camera Control

Syntax

Syntax:
effect ppEffectAdjust settings
Parameters:
effect: String or Number
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 Effects ppEffectForceInNVG ppEffectEnable ppEffectEnabled ppEffectDestroy ppEffectCreate ppEffectCommitted ppEffectCommit setPiPEffect

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