BIS fnc displayColorSet: Difference between revisions

Latest revision as of 01:36, 1 August 2022

Hover & click on the images for 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:: [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

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;

: 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

@@ Line 13: / Line 13: @@
 Display must be already using color macros, function will just refresh the values according to current color settings.
-|s1= [displayClass, display, commitTime, code] call BIS_fnc_displayColorSet
+|s1= [displayClass, display, commitTime, code] call [[BIS_fnc_displayColorSet]]
 |p1= displayClass: [[Config]] - display config class
@@ Line 19: / Line 19: @@
 |p2= display: [[Display]]
-|p3= commitTime (Optional): [[Number]] - Commit time
+|p3= commitTime: [[Number]] - (Optional, default 0) commit time
-|p4= code (Optional): [[Code]] - Code executed for every control element (which is passed as _this)
+|p4= code: [[Code]] - (Optional, default <sqf inline>{}</sqf>) code executed for every control element (which is passed as _this)
-|r1=[[Boolean]]
+|r1= [[Boolean]]
-|x1= <code>[<nowiki/>[[configFile]] >> (GUI_classes [[select]] _forEachIndex),_x] [[call]] [[BIS_fnc_displayColorSet]];</code>
+|x1= <sqf>[configFile >> (GUI_classes select _forEachIndex), _x] call BIS_fnc_displayColorSet;</sqf>
-|x2= <code>[
-	configfile >> _class,
+|x2= <sqf>
+[
+	configFile >> _class,
 	_display,
 ,
 	{
-		_this [[ctrlSetFade]] 0;
+		_this ctrlSetFade 0;
-		_this [[ctrlCommit]] 0.5;
+		_this ctrlCommit 0.5;
 	}
-] call bis_fnc_displayColorSet;</code>
+] call BIS_fnc_displayColorSet;
+</sqf>
-|seealso=
+|seealso= [[BIS_fnc_displayColorGet]]
 }}