ppEffectCreate: Difference between revisions

From Bohemia Interactive Community
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Arma[ _]3(\|.*)\]\]" to "{{GameCategory|arma3|Scripting Commands}}")
(Add priority issue example)
 
(44 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma2 |Game name=
|game1= arma2
|version1= 1.00


|1.00|Game version=
|game2= arma2oa
|version2= 1.50


|gr1= Camera Control |GROUP1=
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| Creates [[Post process effects]] specified by effect name and priority. Supported effects are:<br>
|game4= arma3
|version4= 0.50


* [[Post_process_effects#RadialBlur|"RadialBlur"]]
|gr1= Camera Control
* [[Post_process_effects#ChromAberration|"ChromAberration"]]
* [[Post_process_effects#WetDistortion|"WetDistortion"]]
* [[Post_process_effects#ColorCorrections|"ColorCorrections"]]
* [[Post_process_effects#DynamicBlur|"DynamicBlur"]]
* [[Post_process_effects#FilmGrain|"FilmGrain"]]
* [[Post_process_effects#ColorInversion|"ColorInversion"]]


|DESCRIPTION=
|descr= Creates [[Post Process Effects]] specified by effect name and priority.<br>
____________________________________________________________________________________________
Supported effects:
{{Columns|4|
* [[Post Process Effects#RadialBlur|"RadialBlur"]]
* [[Post Process Effects#ChromAberration|"ChromAberration"]]
* [[Post Process Effects#WetDistortion|"WetDistortion"]]
* [[Post Process Effects#ColorCorrections|"ColorCorrections"]]
* [[Post Process Effects#DynamicBlur|"DynamicBlur"]]
* [[Post Process Effects#FilmGrain|"FilmGrain"]]
* [[Post Process Effects#ColorInversion|"ColorInversion"]]
* [[Post Process Effects#SSAO|"SSAO"]]
* [[Post Process Effects#Resolution|"Resolution"]]
}}


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


|p1= [name, priority]: [[Array]] |Parameter1=
|p1= name: [[String]] - name of effect type
|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=
|p2= priority: [[Number]] - unique priority, defines order of applying effect to the scene. If there is another effect using the same priority, creation will fail


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


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


|p21= [name1, priority1]: [[Array]] |PARAMETER21=
|p21= nameN: [[String]] - name of effect type


|p22= name: [[String]] - name of effect type.  |PARAMETER22=
|p22= priorityN: [[Number]] - unique priority, defines order of applying effect to the scene. If there is another effect using the same priority, creation will fail
|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= <sqf>_ppGrain = ppEffectCreate ["filmGrain", 2005];</sqf>
____________________________________________________________________________________________


| [[Post process effects]], [[ppEffectForceInNVG]], [[ppEffectEnable]], [[ppEffectEnabled]], [[ppEffectDestroy]], [[ppEffectCommit]], [[ppEffectCommitted]], [[ppEffectAdjust]] |SEEALSO=
|x2= If an effect ID is already used, the effect is not created. Use the following:
<sqf>
private _name = "ChromAberration";
private _priority = 200;
private _handle = -1;
while
{
_handle = ppEffectCreate [_name, _priority];
_handle < 0;
} do {
_priority = _priority + 1;
};


|  |MPBEHAVIOUR=
// _handle can be used here as usual
____________________________________________________________________________________________
</sqf>
}}
or
<sqf>
private _name = "ChromAberration";
private _priority = 200;
private _handle = -1;
waitUntil { _handle = ppEffectCreate [_name, _priority]; _priority = _priority + 1; _handle > 0; };


<h3 style='display:none'>Notes</h3>
// _handle can be used here as usual
<dl class='command_description'>
</sqf>
<!-- Note Section BEGIN -->
For some examples, check [http://forums.bistudio.com/showthread.php?t=75528 this topic] - [[User:Lou Montana|Lou Montana]]
<!-- Note Section END -->
</dl>


<h3 style='display:none'>Bottom Section</h3>
|seealso= [[Post Process Effects]] [[ppEffectForceInNVG]] [[ppEffectEnable]] [[ppEffectEnabled]] [[ppEffectDestroy]] [[ppEffectCommit]] [[ppEffectCommitted]] [[ppEffectAdjust]]
}}


{{GameCategory|arma3|Scripting Commands}}
{{Note
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]
|user= Lou Montana
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
|timestamp= 20090629223300
|text= For some examples, check {{Link|http://forums.bistudio.com/showthread.php?t{{=}}75528|this forums' topic}}.
}}


<!-- CONTINUE Notes -->
{{Note
<dl class="command_description">
|user= Raymix (DayZ)
<dd class="notedate">Posted on July 24, 2015 - 04:08 (UTC)</dd>
|timestamp= 20150624040800
<dt class="note">[[User:Raymix|Raymix]]</dt>
|text= "wetDistortion" only works if handle is used.
<dd class="note">"wetDistortion" only works if handle is used. Arma 3 (1.48.131561)
|game= arma3
</dd>
|version= 1.48
</dl>
}}
<!-- DISCONTINUE Notes -->

Latest revision as of 10:54, 16 July 2024

Logo A2.png 1.00A2 OA Logo.png 1.50tkoh logo small.png 1.00Arma 3 logo black.png 0.50
Hover & click on the images for description

Description

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

Syntax

Syntax:
ppEffectCreate [name, priority]
Parameters:
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:
nameN: String - name of effect type
priorityN: 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];
Example 2:
If an effect ID is already used, the effect is not created. Use the following:
private _name = "ChromAberration"; private _priority = 200; private _handle = -1; while { _handle = ppEffectCreate [_name, _priority]; _handle < 0; } do { _priority = _priority + 1; }; // _handle can be used here as usual
or
private _name = "ChromAberration"; private _priority = 200; private _handle = -1; waitUntil { _handle = ppEffectCreate [_name, _priority]; _priority = _priority + 1; _handle > 0; }; // _handle can be used here as usual

Additional Information

See also:
Post Process Effects ppEffectForceInNVG ppEffectEnable ppEffectEnabled ppEffectDestroy ppEffectCommit ppEffectCommitted ppEffectAdjust

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
Lou Montana - c
Posted on Jun 29, 2009 - 22:33 (UTC)
For some examples, check this forums' topic.
Raymix (DayZ) - c
Posted on Jun 24, 2015 - 04:08 (UTC)
Arma 3 logo black.png 1.48

"wetDistortion" only works if handle is used.

Retrieved from "https://community.bistudio.com/wiki?title=ppEffectCreate&oldid=365058"