ppEffectCreate: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "_{10,} " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments( \("local" or "global"\))?|Effects|Multiplayer Effects( \("local" or "global"\))?|Multiplayer Exe...)
Line 1: Line 1:
{{Command|Comments=
{{Command


| arma2 |Game name=
| arma2


|1.00|Game version=
|1.00


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


| 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 17: Line 17:
* [[Post_process_effects#ColorInversion|"ColorInversion"]]
* [[Post_process_effects#ColorInversion|"ColorInversion"]]


|DESCRIPTION=


| '''ppEffectCreate''' [name, priority] |SYNTAX=


|p1= [name, priority]: [[Array]] |Parameter1=
| '''ppEffectCreate''' [name, priority]
|p2= name: [[String]] - name of effect type.  |PARAMETER2=


|p3= priority: [[Number]] - unique priority, defines order of applying effect to the scene. If there is another effect using the same priority, creation will fail. |PARAMETER3=
|p1= [name, priority]: [[Array]]
|p2= name: [[String]] - name of effect type.


| [[Number]] - handle or -1 if failed |RETURNVALUE=
|p3= priority: [[Number]] - unique priority, defines order of applying effect to the scene. If there is another effect using the same priority, creation will fail.


|s2= '''ppEffectCreate''' [<nowiki/>[name1, priority1],...] |SYNTAX2=
| [[Number]] - handle or -1 if failed
 
|s2= '''ppEffectCreate''' [<nowiki/>[name1, priority1],...]


|p21= [name1, priority1]: [[Array]] |PARAMETER21=
|p21= [name1, priority1]: [[Array]] |PARAMETER21=
Line 35: Line 35:
|p23= priority: [[Number]] - unique priority, defines order of applying effect to the scene. If there is another effect using the same priority, creation will fail.|PARAMETER23=
|p23= priority: [[Number]] - unique priority, defines order of applying effect to the scene. If there is another effect using the same priority, creation will fail.|PARAMETER23=


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


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


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


|  |MPBEHAVIOUR=
|  |MPBEHAVIOUR=

Revision as of 02:11, 18 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)