BIS fnc setPPeffectTemplate: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|= Game version" to "|Game version=")
m (Some wiki formatting)
 
(34 intermediate revisions by 2 users not shown)
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]].
____________________________________________________________________________________________


| Apply post-process effects according to template from [[Description.ext#CfgPostprocessTemplates|CfgPostprocessTemplates]]. |DESCRIPTION=
|s1= [template, transition, global] call [[BIS_fnc_setPPeffectTemplate]]
____________________________________________________________________________________________


| [template, transition, global] call [[BIS_fnc_setPPeffectTemplate]]; |SYNTAX=
|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 />
Available game templates are:
Available game templates are:
* "Default"
* "Default"
Line 19: Line 16:
* "Mediterranean"
* "Mediterranean"
* "EastWind"
* "EastWind"
* "RealIsBrown" |PARAMETER1=
* "RealIsBrown"


|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


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


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


|x2= <code>"RealIsBrown" [[call]] [[BIS_fnc_setPPeffectTemplate]];</code> |EXAMPLE2=
|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> |EXAMPLE3=
|x3= <sqf>"MyPurplePP" call BIS_fnc_setPPeffectTemplate; // can use a template defined in Description.ext</sqf>
____________________________________________________________________________________________


| [[Post process effects]], [[ppEffectCreate]], [[ppEffectForceInNVG]], [[ppEffectEnable]], [[ppEffectEnabled]], [[ppEffectDestroy]], [[ppEffectCommit]], [[ppEffectCommitted]], [[ppEffectAdjust]] |SEEALSO=
|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}}]]

Latest revision as of 23:24, 12 July 2022

Arma 3 logo black.png1.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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_setPPeffectTemplate&oldid=327498"