ppEffectCreate: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Fix bad regex effects)
Line 29: Line 29:
| [[Number]] - handle or -1 if failed |RETURNVALUE=  
| [[Number]] - handle or -1 if failed |RETURNVALUE=  


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


|p21= [name1, priority1]: [[Array]] |PARAMETER21=
|p21= [name1, priority1]: [[Array]] |PARAMETER21=
Line 36: Line 36:
|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=(.*)|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=
____________________________________________________________________________________________
____________________________________________________________________________________________
}}
}}
Line 58: Line 57:
<h3 style='display:none'>Bottom Section</h3>
<h3 style='display:none'>Bottom Section</h3>


[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]

Revision as of 20:27, 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:
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)