BIS fnc setPPeffectTemplate: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl> " to "") |
Lou Montana (talk | contribs) m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...) |
||
| Line 1: | Line 1: | ||
{{Function | {{Function | ||
| arma3 | | arma3 | ||
|1.00 | |1.00 | ||
|gr1 = Systems | |gr1 = Systems | ||
| Apply post-process effects according to template from [[Description.ext#CfgPostprocessTemplates|CfgPostprocessTemplates]]. | | Apply post-process effects according to template from [[Description.ext#CfgPostprocessTemplates|CfgPostprocessTemplates]]. | ||
| [template, transition, global] call [[BIS_fnc_setPPeffectTemplate]]; | | [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 17: | Line 17: | ||
* "Mediterranean" | * "Mediterranean" | ||
* "EastWind" | * "EastWind" | ||
* "RealIsBrown" | * "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 | ||
| Line 23: | Line 23: | ||
|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 true in MP, false in SP) should the post-process be broadcast over the network | ||
| [[Boolean]] - true when done | | [[Boolean]] - true when done | ||
|x1= <code>["Mediterranean", 3, false] [[call]] [[BIS_fnc_setPPeffectTemplate]];</code> | |x1= <code>["Mediterranean", 3, false] [[call]] [[BIS_fnc_setPPeffectTemplate]];</code> | ||
|x2= <code>"RealIsBrown" [[call]] [[BIS_fnc_setPPeffectTemplate]];</code> | |x2= <code>"RealIsBrown" [[call]] [[BIS_fnc_setPPeffectTemplate]];</code> | ||
|x3= <code>"MyPurplePP" [[call]] [[BIS_fnc_setPPeffectTemplate]]; {{codecomment|// can use a template defined in [[Description.ext#CfgPostprocessTemplates|Description.ext]]}}</code> | |x3= <code>"MyPurplePP" [[call]] [[BIS_fnc_setPPeffectTemplate]]; {{codecomment|// can use a template defined in [[Description.ext#CfgPostprocessTemplates|Description.ext]]}}</code> | ||
| [[Post process effects]], [[ppEffectCreate]], [[ppEffectForceInNVG]], [[ppEffectEnable]], [[ppEffectEnabled]], [[ppEffectDestroy]], [[ppEffectCommit]], [[ppEffectCommitted]], [[ppEffectAdjust]] | | [[Post process effects]], [[ppEffectCreate]], [[ppEffectForceInNVG]], [[ppEffectEnable]], [[ppEffectEnabled]], [[ppEffectDestroy]], [[ppEffectCommit]], [[ppEffectCommitted]], [[ppEffectAdjust]] | ||
}} | }} | ||
Revision as of 23:48, 17 January 2021
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