BIS fnc setPPeffectTemplate: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) (Page filling) |
m (template:command argument fix) |
||
| Line 8: | Line 8: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| 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= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [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 /> | ||
| Line 19: | Line 19: | ||
* "Mediterranean" | * "Mediterranean" | ||
* "EastWind" | * "EastWind" | ||
* "RealIsBrown" |= | * "RealIsBrown" |PARAMETER1= | ||
|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 25: | Line 25: | ||
|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 |RETURNVALUE= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
|x1= <code>["Mediterranean", 3, false] [[call]] [[BIS_fnc_setPPeffectTemplate]];</code> |= | |x1= <code>["Mediterranean", 3, false] [[call]] [[BIS_fnc_setPPeffectTemplate]];</code> |EXAMPLE1= | ||
|x2= <code>"RealIsBrown" [[call]] [[BIS_fnc_setPPeffectTemplate]];</code> |= | |x2= <code>"RealIsBrown" [[call]] [[BIS_fnc_setPPeffectTemplate]];</code> |EXAMPLE2= | ||
|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> |EXAMPLE3= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [[Post process effects]], [[ppEffectCreate]], [[ppEffectForceInNVG]], [[ppEffectEnable]], [[ppEffectEnabled]], [[ppEffectDestroy]], [[ppEffectCommit]], [[ppEffectCommitted]], [[ppEffectAdjust]] |= | | [[Post process effects]], [[ppEffectCreate]], [[ppEffectForceInNVG]], [[ppEffectEnable]], [[ppEffectEnabled]], [[ppEffectDestroy]], [[ppEffectCommit]], [[ppEffectCommitted]], [[ppEffectAdjust]] |SEEALSO= | ||
}} | }} | ||
Revision as of 14:33, 7 April 2019
Description
- Description:
- Apply post-process effects according to template from CfgPostprocessTemplates.
- Execution:
- call
- Groups:
- Uncategorised
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