BIS fnc setPPeffectTemplate: Difference between revisions

Latest revision as of 00:24, 13 July 2022

1.00

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

@@ Line 1: / Line 1: @@
+{{RV|type=function
-{{Function|= Comments
+|game1= arma3
-____________________________________________________________________________________________
+|version1= 1.00
-| arma3 |= Game name
+|gr1= Systems
-|1.00|= Game version
+|descr= Apply post-process effects according to template from [[Description.ext#CfgPostprocessTemplates|CfgPostprocessTemplates]].
-____________________________________________________________________________________________
-| <pre>/*
+|s1= [template, transition, global] call [[BIS_fnc_setPPeffectTemplate]]
-	Description:
+|p1= template: [[String]] - (Optional, default "Default") the template name. An invalid value will fall back to "Default".<br>
-	Apply post-process effects according to template from CfgPostprocessTemplates
+Available game templates are:
+* "Default"
+* "BlackAndWhite"
+* "Mediterranean"
+* "EastWind"
+* "RealIsBrown"
-	Parameter(s):
+|p2= transition: [[Number]] - (Optional, default 0) time to apply the post-process
-: STRING - template class
-(Optional): NUMBER - commit time in seconds (default: 0)
-(Optional): BOOL - true for global execution (default: true)
-	Returns:
+|p3= global: [[Boolean]] - (Optional, default [[isMultiplayer]]) should the post-process be broadcast over the network
-	BOOL
-*/
-#define VALUEVAR	"bis_fnc_setppeffecttemplate_value"
+|r1= [[Boolean]] - true when done
-</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
+|x1= <sqf>["Mediterranean", 3, false] call BIS_fnc_setPPeffectTemplate;</sqf>
-____________________________________________________________________________________________
-| <!-- [] call [[BIS_fnc_setPPeffectTemplate]]; --> |= Syntax
+|x2= <sqf>"RealIsBrown" call BIS_fnc_setPPeffectTemplate;</sqf>
-|p1= |= Parameter 1
+|x3= <sqf>"MyPurplePP" call BIS_fnc_setPPeffectTemplate; // can use a template defined in Description.ext</sqf>
-| |= Return value
-____________________________________________________________________________________________
-|x1= <code></code> |=
-____________________________________________________________________________________________
-| |= See also
+|seealso= [[Post Process Effects]] [[ppEffectCreate]] [[ppEffectForceInNVG]] [[ppEffectEnable]] [[ppEffectEnabled]] [[ppEffectDestroy]] [[ppEffectCommit]] [[ppEffectCommitted]] [[ppEffectAdjust]]
 }}
-<h3 style="display:none">Notes</h3>
-<dl class="command_description">
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
-</dl>
-<h3 style="display:none">Bottom Section</h3>
-[[Category:Function Group: Environment|{{uc:setPPeffectTemplate}}]]
-[[Category:Functions|{{uc:setPPeffectTemplate}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:setPPeffectTemplate}}]]