BIS fnc setPPeffectTemplate: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision)
(Page filling)
Line 8: Line 8:
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>/*
| Apply post-process effects according to template from [[Description.ext#CfgPostprocessTemplates|CfgPostprocessTemplates]]. |= Description
____________________________________________________________________________________________


Description:
| [template, transition, global] call [[BIS_fnc_setPPeffectTemplate]]; |= Syntax
Apply post-process effects according to template from CfgPostprocessTemplates


Parameter(s):
|p1= template: [[String]] - (Optional, default "Default") the template name. An invalid value will fall back to "Default".<br />
0: STRING - template class
Available game templates are:
1 (Optional): NUMBER - commit time in seconds (default: 0)
* "Default"
2 (Optional): BOOL - true for global execution (default: true)
* "BlackAndWhite"
* "Mediterranean"
* "EastWind"
* "RealIsBrown" |= Parameter 1


Returns:
|p2= transition: [[Number]] - (Optional, default 0) time to apply the post-process
BOOL
*/


#define VALUEVAR "bis_fnc_setppeffecttemplate_value"
|p3= global: [[Boolean]] - (Optional, default true in MP, false in SP) should the post-process be broadcast over the network


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
| [[Boolean]] - true when done |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_setPPeffectTemplate]]; --> |= Syntax
|x1= <code>["Mediterranean", 3, false] [[call]] [[BIS_fnc_setPPeffectTemplate]];</code> |= Example 1
 
|p1= |= Parameter 1


| |= Return value
|x2= <code>"RealIsBrown" [[call]] [[BIS_fnc_setPPeffectTemplate]];</code> |= Example 2
____________________________________________________________________________________________


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


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


Revision as of 01:15, 18 April 2018


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:
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

Notes

Bottom Section

Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_setPPeffectTemplate&oldid=106589"