BIS fnc setPPeffectTemplate: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<code>([^<]*)\[\[([a-zA-Z][a-zA-Z0-9_]+)\]\]([^<]*) *<\/code>" to "<code>$1$2$3</code>")
m (Text replacement - " |s1=[" to " |s1= [")
Line 8: Line 8:
|descr= Apply post-process effects according to template from [[Description.ext#CfgPostprocessTemplates|CfgPostprocessTemplates]].
|descr= Apply post-process effects according to template from [[Description.ext#CfgPostprocessTemplates|CfgPostprocessTemplates]].


|s1=[template, transition, global] call [[BIS_fnc_setPPeffectTemplate]]
|s1= [template, transition, global] call [[BIS_fnc_setPPeffectTemplate]]


|p1= template: [[String]] - (Optional, default "Default") the template name. An invalid value will fall back to "Default".<br>
|p1= template: [[String]] - (Optional, default "Default") the template name. An invalid value will fall back to "Default".<br>

Revision as of 23:11, 12 July 2022

Hover & click on the images for description

Description

Description:
Apply post-process effects according to template from CfgPostprocessTemplates.
Execution:
call
Groups:
Systems

Syntax

Syntax:
[template, transition, global] call BIS_fnc_setPPeffectTemplate
Parameters:
template: String - (Optional, default "Default") the template name. An invalid value will fall back to "Default".
Available game templates are:
  • "Default"
  • "BlackAndWhite"
  • "Mediterranean"
  • "EastWind"
  • "RealIsBrown"
transition: Number - (Optional, default 0) time to apply the post-process
global: Boolean - (Optional, default true in MP, false in SP) should the post-process be broadcast over the network
Return Value:
Boolean - true when done

Examples

Example 1:
["Mediterranean", 3, false] call BIS_fnc_setPPeffectTemplate;
Example 2:
"RealIsBrown" call BIS_fnc_setPPeffectTemplate;
Example 3:
"MyPurplePP" call BIS_fnc_setPPeffectTemplate; // can use a template defined in Description.ext

Additional Information

See also:
Post process effects ppEffectCreate 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