ppEffectCreate: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(see also)
m (template:command argument fix)
Line 23: Line 23:


|p1= [name, priority]: [[Array]] |=
|p1= [name, priority]: [[Array]] |=
|p2= name: [[String]] - name of effect type.  |= PARAMETER1
|p2= name: [[String]] - name of effect type.  |PARAMETER1=
|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. |= 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. |PARAMETER2=


| [[Number]] - handle or -1 if failed |= RETURNVALUE
| [[Number]] - handle or -1 if failed |RETURNVALUE=  


| s2= '''ppEffectCreate''' <nowiki>[</nowiki>[name1, priority1],...] |= Syntax
| s2= '''ppEffectCreate''' <nowiki>[</nowiki>[name1, priority1],...] |= Syntax


|p21= [name1, priority1]: [[Array]] |=
|p21= [name1, priority1]: [[Array]] |=
|p22= name: [[String]] - name of effect type.  |= PARAMETER1
|p22= name: [[String]] - name of effect type.  |PARAMETER1=
|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.|= PARAMETER2
|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.|PARAMETER2=


| r2= [[Array]] - [handle1,...] array of effects handles or [[Nothing]] if failed |= RETURNVALUE
| r2= [[Array]] - [handle1,...] array of effects handles or [[Nothing]] if failed |RETURNVALUE=  
____________________________________________________________________________________________
____________________________________________________________________________________________


|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 10:35, 7 April 2019

Hover & click on the images for description

Description

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

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 - [handle1,...] array of effects handles 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)