ppEffectCreate: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " \| ?r2=(.*)\|RETURNVALUE= *" to " |r2=(.*)|RETURNVALUE2=")
mNo edit summary
Line 25: Line 25:
|p2= name: [[String]] - name of effect type.  |PARAMETER2=
|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. |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=


| [[Number]] - handle or -1 if failed |RETURNVALUE=  
| [[Number]] - handle or -1 if failed |RETURNVALUE=  
Line 33: Line 33:
|p21= [name1, priority1]: [[Array]] |PARAMETER21=
|p21= [name1, priority1]: [[Array]] |PARAMETER21=


|p22= name: [[String]] - name of effect type.  |PARAMETER1=
|p22= name: [[String]] - name of effect type.  |PARAMETER22=
|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.|PARAMETER23=


|r2=(.*)|RETURNVALUE2=  
|r2=(.*)|RETURNVALUE2=  

Revision as of 19:25, 24 September 2020

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:
(.*)

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)