BIS fnc displayColorSet: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Some wiki formatting)
 
(54 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= tkoh
____________________________________________________________________________________________
|version1= 1.00


| tkoh |= Game name
|game2= arma3
|version2= 0.50


|1.00|= Game version
|gr1= GUI
____________________________________________________________________________________________


| <pre>/*
|descr= Applies custom [[User Interface Colors|color settings]] to given [[Display]].


Description:
Display must be already using color macros, function will just refresh the values according to current color settings.
Set display's color


Parameter(s):
|s1= [displayClass, display, commitTime, code] call [[BIS_fnc_displayColorSet]]
_this select 0: STRING - display class
_this select 1: DISPLAY
_this select 2 (Optional): NUMBER - commit time
_this select 3 (Optional): CODE - code executed for every control element (which is passed as _this)


Returns:
|p1= displayClass: [[Config]] - display config class
BOOL
*/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
|p2= display: [[Display]]
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_displayColorSet]]; --> |= Syntax
|p3= commitTime: [[Number]] - (Optional, default 0) commit time


|p1= |= Parameter 1
|p4= code: [[Code]] - (Optional, default <sqf inline>{}</sqf>) code executed for every control element (which is passed as _this)


| |= Return value
|r1= [[Boolean]]
____________________________________________________________________________________________


|x1= <code></code> |=
|x1= <sqf>[configFile >> (GUI_classes select _forEachIndex), _x] call BIS_fnc_displayColorSet;</sqf>
____________________________________________________________________________________________


| |= See also
|x2= <sqf>
[
configFile >> _class,
_display,
0,
{
_this ctrlSetFade 0;
_this ctrlCommit 0.5;
}
] call BIS_fnc_displayColorSet;
</sqf>


|seealso= [[BIS_fnc_displayColorGet]]
}}
}}
<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: GUI|{{uc:displayColorSet}}]]
[[Category:Functions|{{uc:displayColorSet}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:displayColorSet}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:displayColorSet}}]]

Latest revision as of 02:36, 1 August 2022

tkoh logo small.png1.00Arma 3 logo black.png0.50
Hover & click on the images for description

Description

Description:
Applies custom color settings to given Display. Display must be already using color macros, function will just refresh the values according to current color settings.
Execution:
call
Groups:
GUI

Syntax

Syntax:
[displayClass, display, commitTime, code] call BIS_fnc_displayColorSet
Parameters:
displayClass: Config - display config class
display: Display
commitTime: Number - (Optional, default 0) commit time
code: Code - (Optional, default {}) code executed for every control element (which is passed as _this)
Return Value:
Boolean

Examples

Example 1:
[configFile >> (GUI_classes select _forEachIndex), _x] call BIS_fnc_displayColorSet;
Example 2:
[ configFile >> _class, _display, 0, { _this ctrlSetFade 0; _this ctrlCommit 0.5; } ] call BIS_fnc_displayColorSet;

Additional Information

See also:
BIS_fnc_displayColorGet

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_displayColorSet&oldid=329650"