BIS fnc setPPeffectTemplate: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\| *(arg|eff|mp|serverExec|gr[0-9]) *= *(.*) * *\|([^=]{12})" to "|$1=$2 |descr=$3")
m (Some wiki formatting)
 
(15 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{RV|type=function
{{RV|type=function


| arma3
|game1= arma3
 
|version1= 1.00
|1.00


|gr1= Systems
|gr1= Systems
Line 9: 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>
Line 21: Line 20:
|p2= transition: [[Number]] - (Optional, default 0) time to apply the post-process
|p2= transition: [[Number]] - (Optional, default 0) time to apply the post-process


|p3= global: [[Boolean]] - (Optional, default true in MP, false in SP) should the post-process be broadcast over the network
|p3= global: [[Boolean]] - (Optional, default [[isMultiplayer]]) should the post-process be broadcast over the network


|r1= [[Boolean]] - true when done
|r1= [[Boolean]] - true when done


|x1= <code>["Mediterranean", 3, false] [[call]] [[BIS_fnc_setPPeffectTemplate]];</code>
|x1= <sqf>["Mediterranean", 3, false] call BIS_fnc_setPPeffectTemplate;</sqf>


|x2= <code>"RealIsBrown" [[call]] [[BIS_fnc_setPPeffectTemplate]];</code>
|x2= <sqf>"RealIsBrown" call BIS_fnc_setPPeffectTemplate;</sqf>


|x3= <code>"MyPurplePP" [[call]] [[BIS_fnc_setPPeffectTemplate]]; {{codecomment|// can use a template defined in [[Description.ext#CfgPostprocessTemplates|Description.ext]]}}</code>
|x3= <sqf>"MyPurplePP" call BIS_fnc_setPPeffectTemplate; // can use a template defined in Description.ext</sqf>


|seealso= [[Post process effects]], [[ppEffectCreate]], [[ppEffectForceInNVG]], [[ppEffectEnable]], [[ppEffectEnabled]], [[ppEffectDestroy]], [[ppEffectCommit]], [[ppEffectCommitted]], [[ppEffectAdjust]]
|seealso= [[Post Process Effects]] [[ppEffectCreate]] [[ppEffectForceInNVG]] [[ppEffectEnable]] [[ppEffectEnabled]] [[ppEffectDestroy]] [[ppEffectCommit]] [[ppEffectCommitted]] [[ppEffectAdjust]]
}}
}}

Latest revision as of 23:24, 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 isMultiplayer) 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