ppEffectCreate: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Take[ _]On[ _]Helicopters(\|.*)?\]\]" to "{{GameCategory|tkoh|Scripting Commands}}")
m (Text replacement - "_{10,} " to "")
Line 1: Line 1:
{{Command|Comments=
{{Command|Comments=
____________________________________________________________________________________________


| arma2 |Game name=
| arma2 |Game name=
Line 7: Line 6:


|gr1= Camera Control |GROUP1=
|gr1= Camera Control |GROUP1=
____________________________________________________________________________________________


| Creates [[Post process effects]] specified by effect name and priority. Supported effects are:<br>
| Creates [[Post process effects]] specified by effect name and priority. Supported effects are:<br>
Line 20: Line 18:


|DESCRIPTION=
|DESCRIPTION=
____________________________________________________________________________________________


| '''ppEffectCreate''' [name, priority] |SYNTAX=
| '''ppEffectCreate''' [name, priority] |SYNTAX=
Line 39: Line 36:


|r2= [[Array]] of [[Number]]s [handle1, ...] or [[Nothing]] if failed |RETURNVALUE2=
|r2= [[Array]] of [[Number]]s [handle1, ...] or [[Nothing]] if failed |RETURNVALUE2=
____________________________________________________________________________________________


|x1= <code>_ppGrain = [[ppEffectCreate]] ["filmGrain", 2005];</code>|EXAMPLE1=
|x1= <code>_ppGrain = [[ppEffectCreate]] ["filmGrain", 2005];</code>|EXAMPLE1=
____________________________________________________________________________________________


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


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



Revision as of 03:21, 17 January 2021

Hover & click on the images for description

Description

Description:
Creates Post process effects specified by effect name and priority. Supported effects are:
Groups:
Camera Control

Syntax

Syntax:
ppEffectCreate [name, priority]
Parameters:
[name, priority]: Array
name: String - name of effect type.
priority: Number - unique priority, defines order of applying effect to the scene. If there is another effect using the same priority, creation will fail.
Return Value:
Number - handle or -1 if failed

Alternative Syntax

Syntax:
ppEffectCreate [[name1, priority1],...]
Parameters:
[name1, priority1]: Array
name: String - name of effect type.
priority: Number - unique priority, defines order of applying effect to the scene. If there is another effect using the same priority, creation will fail.
Return Value:
Array of Numbers [handle1, ...] or Nothing if failed

Examples

Example 1:
_ppGrain = ppEffectCreate ["filmGrain", 2005];

Additional Information

See also:
Post process effectsppEffectForceInNVGppEffectEnableppEffectEnabledppEffectDestroyppEffectCommitppEffectCommittedppEffectAdjust

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

For some examples, check this topic - Lou Montana

Bottom Section

Posted on July 24, 2015 - 04:08 (UTC)
Raymix
"wetDistortion" only works if handle is used. Arma 3 (1.48.131561)