BIS fnc displayColorGet: Difference between revisions

Latest revision as of 15:53, 8 November 2023

Hover & click on the images for description

Description

Description:

Loads custom color settings from CfgUIDefault. If variables are not stored in profileNamespace yet, the function will declare them.

Arma 3 v1.99
Tag	Variable	Description
"IGUI"	"BCG_RGB"	Backgrounds
	"TEXT_RGB"	Active Elements
	"WARNING_RGB"	Warnings
	"ERROR_RGB"	Errors
	"TACTPING_RGB"	Tactical Ping
"GUI"	"BCG_RGB"	Backgrounds
"GUI"	"TITLETEXT_RGB"	Title Text
"Map"	"BLUFOR"	BLUFOR
	"OPFOR"	OPFOR
	"Independent"	Independent
	"Civilian"	Civilian
	"Unknown"	Unknown
"Subtitles"	"Background"	Subtitle background
"Subtitles"	"Text"	Subtitle text

Take On Helicopters v1.00
Tag	Variable	Description
"IGUI"	"IGUI_TEXT_RGB"	HUD color RGB
"IGUI"	"IGUI_TEXT_COLOR"	HUD color RGBA
"GUI"	"BCG_RGB"	menu background RGB
	"GUI_BCG_COLOR"	menu background RGBA
	"GUI_BCG_MEDIUM_RGB"	button background RGB (darker version of GUI_BCG_RGB)
	"GUI_BCG_MEDIUM_COLOR"	button background RGBA
	"GUI_BCG_ACTIVE_RGB"	active button background color (e.g. focused buttons) RGB

Execution:

call

Groups:

GUI

Syntax

Syntax:: [tag, variable] call BIS_fnc_displayColorGet
Parameters:: tag: String - tag defined in CfgUIDefault
: variable: String - variable defined in "CfgUIColors" >> Variables
Return Value:: Array - in format Color (RGBA)

Alternative Syntax

Syntax:: init call BIS_fnc_displayColorGet
Parameters:: init: Boolean - when used, function will initialize all color presets
Return Value:: Nothing

Examples

Example 1:: ["GUI", "BCG_RGB"] call BIS_fnc_displayColorGet;//Returns menu color

Additional Information

See also:: Color (RGBA) BIS_fnc_colorRGBtoHTML BIS_fnc_colorRGBAtoHTML BIS_fnc_colorRGBAtoTexture

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

@@ Line 1: / Line 1: @@
-{{Function|= Comments
+{{RV|type=function
-____________________________________________________________________________________________
-| TKOH |= Game name
+|game1= tkoh
+|version1= 1.00
-|1.00|= Game version
+|game2= arma3
-____________________________________________________________________________________________
+|version2= 0.50
-| Loads custom [[Interface_Colors|color settings]] from CfgUIDefault. |= Description
+|gr1= GUI
-____________________________________________________________________________________________
-| [tag,variable] call BIS_fnc_displayColorGet; |= Syntax
+|descr= Loads custom [[User Interface Colors|color settings]] from CfgUIDefault.
-|p1= tag: [[String]] - Tag defined in CfgUIDefault |= Parameter 1
+If variables are not stored in [[profileNamespace]] yet, the function will declare them.
-|p2= variable: [[String]] - Variable defined in CfgUIDefault >> Variables |= Parameter 2
+{{{!}}
+{{!}} style="vertical-align: top; width: 50%" {{!}}
+<!-- A3 -->
+{{{!}} class="wikitable"
+{{!}}+ {{arma3}} v1.99
+! Tag !! Variable !! Description
+{{!}}-
+! rowspan="5" {{!}} "IGUI"
+{{!}}"BCG_RGB" {{!}}{{!}} Backgrounds
+{{!}}-
+{{!}} "TEXT_RGB" {{!}}{{!}} Active Elements
+{{!}}-
+{{!}} "WARNING_RGB" {{!}}{{!}} Warnings
+{{!}}-
+{{!}} "ERROR_RGB" {{!}}{{!}} Errors
+{{!}}-
+{{!}} "TACTPING_RGB" {{!}}{{!}} Tactical Ping
+{{!}}-
+! rowspan="2" {{!}} "GUI"
+{{!}} "BCG_RGB" {{!}}{{!}} Backgrounds
+{{!}}-
+{{!}} "TITLETEXT_RGB" {{!}}{{!}} Title Text
+{{!}}-
+! rowspan="5" {{!}} "Map"
+{{!}} "BLUFOR" {{!}}{{!}} BLUFOR
+{{!}}-
+{{!}} "OPFOR" {{!}}{{!}} OPFOR
+{{!}}-
+{{!}} "Independent" {{!}}{{!}} Independent
+{{!}}-
+{{!}} "Civilian" {{!}}{{!}} Civilian
+{{!}}-
+{{!}} "Unknown" {{!}}{{!}} Unknown
+{{!}}-
+! rowspan="2" {{!}} "Subtitles"
+{{!}} "Background" {{!}}{{!}} Subtitle background
+{{!}}-
+{{!}} "Text" {{!}}{{!}} Subtitle text
+{{!}}}
-| [[Array]] - in format [[Color]] |= Return value
+{{!}} style="vertical-align: top; width: 50%" {{!}}
-____________________________________________________________________________________________
+<!-- TKOH -->
+{{{!}} class="wikitable"
-|x1= <code>["GUI","BCG_RGB"] call BIS_fnc_displayColorGet;</code>
+{{!}}+ {{tkoh}} v1.00
-Returns menu color|= Example 1
+! Tag !! Variable !! Description
-____________________________________________________________________________________________
+{{!}}-
+! rowspan="2" {{!}} "IGUI"
+{{!}}"IGUI_TEXT_RGB" {{!}}{{!}} HUD color '''RGB'''
+{{!}}-
+{{!}} "IGUI_TEXT_COLOR" {{!}}{{!}} HUD color '''RGBA'''
+{{!}}-
+! rowspan="5" {{!}} "GUI"
+{{!}} "BCG_RGB" {{!}}{{!}} menu background '''RGB'''
+{{!}}-
+{{!}} "GUI_BCG_COLOR" {{!}}{{!}} menu background '''RGBA'''
+{{!}}-
+{{!}} "GUI_BCG_MEDIUM_RGB" {{!}}{{!}} button background '''RGB''' (darker version of GUI_BCG_RGB)
+{{!}}-
+{{!}} "GUI_BCG_MEDIUM_COLOR" {{!}}{{!}} button background '''RGBA'''
+{{!}}-
+{{!}} "GUI_BCG_ACTIVE_RGB" {{!}}{{!}} active button background color (e.g. focused buttons) '''RGB'''
+{{!}}}
-| |= See also
+{{!}}}
-}}
+|s1= [tag, variable] call [[BIS_fnc_displayColorGet]]
+|p1= tag: [[String]] - tag defined in [[User Interface Colors|CfgUIDefault]]
+|p2= variable: [[String]] - variable defined in "CfgUIColors" >> Variables
+|r1= [[Array]] - in format [[Color|Color (RGBA)]]
+|s2=  init call [[BIS_fnc_displayColorGet]]
-<h3 style="display:none">Notes</h3>
+|p21= init: [[Boolean]] - when used, function will initialize all color presets
-<dl class="command_description">
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
+|r2= [[Nothing]]
-</dl>
-<h3 style="display:none">Bottom Section</h3>
+|x1= <sqf>["GUI", "BCG_RGB"] call BIS_fnc_displayColorGet;//Returns menu color</sqf>
-[[Category:Take_On_Helicopters:_Functions|displayColorGet]]
+|seealso= [[Color|Color (RGBA)]] [[BIS_fnc_colorRGBtoHTML]] [[BIS_fnc_colorRGBAtoHTML]] [[BIS_fnc_colorRGBAtoTexture]]
+}}