ppEffectCreate: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "<dl class='command_description'>" to "<dl class="command_description">") |
Lou Montana (talk | contribs) (Add priority issue example) |
||
(29 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
{{RV|type=command | {{RV|type=command | ||
| arma2 | |game1= arma2 | ||
|version1= 1.00 | |||
|1.00 | |game2= arma2oa | ||
|version2= 1.50 | |||
|game3= tkoh | |||
|version3= 1.00 | |||
|game4= arma3 | |||
|version4= 0.50 | |||
|gr1= Camera Control | |gr1= Camera Control | ||
| Creates [[Post | |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"]] | |||
}} | |||
|s1= [[ppEffectCreate]] [name, priority] | |||
| | |p1= name: [[String]] - name of effect type | ||
| | |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 | ||
| | |r1= [[Number]] - handle or -1 if failed | ||
| [[ | |s2= [[ppEffectCreate]] [<nowiki/>[name1, priority1], ...] | ||
| | |p21= nameN: [[String]] - name of effect type | ||
| | |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 | ||
| | |r2= [[Array]] of [[Number]]s [handle1, ...] or [[Nothing]] if failed | ||
| | |x1= <sqf>_ppGrain = ppEffectCreate ["filmGrain", 2005];</sqf> | ||
| | |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; | |||
}; | |||
// _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; }; | |||
// _handle can be used here as usual | |||
</sqf> | |||
</ | |||
|seealso= [[Post Process Effects]] [[ppEffectForceInNVG]] [[ppEffectEnable]] [[ppEffectEnabled]] [[ppEffectDestroy]] [[ppEffectCommit]] [[ppEffectCommitted]] [[ppEffectAdjust]] | |||
}} | |||
{{ | {{Note | ||
|user= Lou Montana | |||
|timestamp= 20090629223300 | |||
|text= For some examples, check {{Link|http://forums.bistudio.com/showthread.php?t{{=}}75528|this forums' topic}}. | |||
}} | |||
{{Note | |||
|user= Raymix (DayZ) | |||
|timestamp= 20150624040800 | |||
|text= "wetDistortion" only works if handle is used. | |||
|game= arma3 | |||
|version= 1.48 | |||
}} |
Latest revision as of 10:54, 16 July 2024
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:
- Example 2:
- If an effect ID is already used, the effect is not created. Use the following:
or
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
- Posted on Jun 29, 2009 - 22:33 (UTC)
- For some examples, check this forums' topic.
- Posted on Jun 24, 2015 - 04:08 (UTC)
-
"wetDistortion" only works if handle is used.