BIS fnc setPPeffectTemplate: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Text replacement - "_{10,} " to "")
Line 1: Line 1:
{{Function|Comments=
{{Function|Comments=
____________________________________________________________________________________________


| arma3 |Game name=
| arma3 |Game name=
Line 7: Line 6:


|gr1 = Systems |GROUP1=
|gr1 = Systems |GROUP1=
____________________________________________________________________________________________


| Apply post-process effects according to template from [[Description.ext#CfgPostprocessTemplates|CfgPostprocessTemplates]]. |DESCRIPTION=
| Apply post-process effects according to template from [[Description.ext#CfgPostprocessTemplates|CfgPostprocessTemplates]]. |DESCRIPTION=
____________________________________________________________________________________________


| [template, transition, global] call [[BIS_fnc_setPPeffectTemplate]]; |SYNTAX=
| [template, transition, global] call [[BIS_fnc_setPPeffectTemplate]]; |SYNTAX=
Line 27: Line 24:


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


|x1= <code>["Mediterranean", 3, false] [[call]] [[BIS_fnc_setPPeffectTemplate]];</code> |EXAMPLE1=
|x1= <code>["Mediterranean", 3, false] [[call]] [[BIS_fnc_setPPeffectTemplate]];</code> |EXAMPLE1=
Line 34: Line 30:


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


| [[Post process effects]], [[ppEffectCreate]], [[ppEffectForceInNVG]], [[ppEffectEnable]], [[ppEffectEnabled]], [[ppEffectDestroy]], [[ppEffectCommit]], [[ppEffectCommitted]], [[ppEffectAdjust]] |SEEALSO=
| [[Post process effects]], [[ppEffectCreate]], [[ppEffectForceInNVG]], [[ppEffectEnable]], [[ppEffectEnabled]], [[ppEffectDestroy]], [[ppEffectCommit]], [[ppEffectCommitted]], [[ppEffectAdjust]] |SEEALSO=

Revision as of 00:48, 17 January 2021

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 effectsppEffectCreateppEffectForceInNVGppEffectEnableppEffectEnabledppEffectDestroyppEffectCommitppEffectCommittedppEffectAdjust

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

Notes

Bottom Section