User Interface Colors: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (update)
 
(11 intermediate revisions by 4 users not shown)
Line 1: Line 1:
[[Category:Take On Helicopters: Editing]]
[[{{tkoh}}]] introduced ability to recolor menu and HUD colors. Community creators can define new presets or use user's colors using following configs and functions.
[[File:UI InterfaceColors.jpg|thumb|200px|Interface Colors menu]]
{{TOC|none}}
[[Take On Helicopters]] introduced ability to recolor menu and HUD colors. Community creators can define new presets or use user's colors using following configs and functions.


== Functions ==
== Presets ==
* [[BIS_fnc_displayColorGet]]
* [[BIS_fnc_displayColorSet]]


== Sample Config ==
[[File:UI InterfaceColors.jpg|thumb|200px|Interface Colors menu]]
  class CfgUIDefault
Presets are available for users in Options > Game Options > Interface Colors menu. Anybody can define new presets and categories.
  class CfgUIDefault // In Arma 3 the class was renamed to CfgUIColors
  {
  {
  {{codecomment|//--- Tag}}
  {{cc|--- Tag}}
  class IGUI
  class {{Color|orange|'''IGUI'''}}
  {
  {
  {{codecomment|//--- Name displayed in menu}}
  {{cc|--- Name displayed in menu}}
  displayName = $STR_HSIM_CfgUIDefault_IGUI_0;
  displayName = "$STR_HSIM_CfgUIDefault_IGUI_0";
  {{codecomment|//--- Color variables}}
  {{cc|--- Color variables}}
  class Variables
  class Variables
  {
  {
  {{codecomment|//--- Identification class ised by presets and scripts}}
  {{cc|--- Identification class ised by presets and scripts}}
  class TEXT_RGB
  class {{Color|green|'''TEXT_RGB'''}}
  {
  {
  {{codecomment|//--- Name displayed in menu}}
  {{cc|--- Name displayed in menu}}
  displayName = $STR_HSIM_CfgUIDefault_IGUI_Variables_TEXT_RGB_0;
  displayName = "$STR_HSIM_CfgUIDefault_IGUI_Variables_TEXT_RGB_0";
  {{codecomment|//--- Preview picture background}}
  {{cc|--- Preview picture background}}
  previewBackground = "\hsim\UI_H\data\loadscreen_generic_co.paa";
  previewBackground = "\hsim\UI_H\data\loadscreen_generic_co.paa";
  {{codecomment|//--- Preview picture (when 1 instead of [[String]], whole menu is recolored instead)}}
  {{cc|--- Preview picture (when 1 instead of [[String]], whole menu is recolored instead)}}
  preview = "\hsim\UI_H\data\cursor_w_view_gs.paa";
  preview = "\hsim\UI_H\data\cursor_w_view_gs.paa";
  {{codecomment|//--- Preview picture width}}
  {{cc|--- Preview picture width}}
  previewW = 4 * GUI_GRID_W;
  previewW = 4 * GUI_GRID_W;
  {{codecomment|//--- Preview picture height}}
  {{cc|--- Preview picture height}}
  previewH = 4 * GUI_GRID_H;
  previewH = 4 * GUI_GRID_H;
  };
  };
  };
  };
  {{codecomment|//--- Color presets}}
  {{cc|--- Color presets}}
  class Presets
  class Presets
  {
  {
  class PresetDefault
  class PresetDefault
  {
  {
  {{codecomment|//--- Name displayed in menu}}
  {{cc|--- Name displayed in menu}}
  displayName = $STR_HSIM_CfgUIDefault_IGUI_Presets_PresetGreen_0;
  displayName = "$STR_HSIM_CfgUIDefault_IGUI_Presets_PresetGreen_0";
  {{codecomment|//--- Class of modified variable (TEXT_RGB) with RGBA values}}
  {{cc|--- Class of modified variable (TEXT_RGB) with RGBA values}}
  TEXT_RGB[] = {IGUI_TEXT_RGB_RDef,IGUI_TEXT_RGB_GDef,IGUI_TEXT_RGB_BDef,IGUI_TEXT_RGB_ADef};
  {{Color|green|'''TEXT_RGB'''}}[] = {0,1,0.05,0.8};
  {{codecomment|//--- When 1, preset is used as default}}
  {{cc|--- When 1, preset is used as default}}
  default = 1;
  default = 1;
  };
  };
  class PresetBlue
  class PresetBlue
  {
  {
  displayName = $STR_HSIM_CfgUIDefault_IGUI_Presets_PresetDefault_0;
  displayName = "$STR_HSIM_CfgUIDefault_IGUI_Presets_PresetDefault_0";
  TEXT_RGB[] = {0,1,1,0.8};
  {{Color|green|'''TEXT_RGB'''}}[] = {0,1,1,0.8};
  };
  };
  };
  };
  };
  };
  };
  };
== Macros ==
=== Adding New ===
System stores preset variables into [[profileNamespace]] upon startup. UI controls can link to them using [[getVariable]] command.
Using [[PreProcessor_Commands|macros]] helps to keep the code simple and maintain it through development.
#define IGUI_TEXT_RGB_R "([[profileNamespace]] [[getVariable]] ['{{Color|orange|'''IGUI'''}}_{{Color|green|'''TEXT_RGB'''}}_R', 0])"
#define IGUI_TEXT_RGB_G "([[profileNamespace]] [[getVariable]] ['{{Color|orange|'''IGUI'''}}_{{Color|green|'''TEXT_RGB'''}}_G', 1])"
#define IGUI_TEXT_RGB_B "([[profileNamespace]] [[getVariable]] ['{{Color|orange|'''IGUI'''}}_{{Color|green|'''TEXT_RGB'''}}_B', 0.05])"
#define IGUI_TEXT_RGB_A "([[profileNamespace]] [[getVariable]] ['{{Color|orange|'''IGUI'''}}_{{Color|green|'''TEXT_RGB'''}}_A', 0.8])"
Explanation:
* '''#define IGUI_TEXT_RGB_R''' - macro name. Can be anything, but naming it based on preset is recommended.
* '''"(profileNamespace getVariable ['IGUI_TEXT_RGB_R',0])"''' - actual value. Must be [[String]], otherwise macro would be terminated after first comma (,)
** '''IGUI_TEXT_RGB''' - variable created by system based on preset. Created from <tag>_<variable>
** '''0''' - default value in case variable is not found (used on first game start)
=== Existing ===
Color macros are defined in ''defineCommon.inc'' (see [[User Interface Macros]] for more details). Following defines are based on user modifiable colors:
* GUI (menus)
** '''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
* IGUI (HUD)
** '''IGUI_TEXT_RGB''' - HUD color RGB
** '''IGUI_TEXT_COLOR''' - HUD color RGBA
=== Sample Configs ===
Set text/picture color to HUD color
<syntaxhighlight lang="cpp">
colorText[] = IGUI_TEXT_COLOR;
</syntaxhighlight>
Set text/picture color to HUD color with fixed alpha (e.g. override user transparency settings)
<syntaxhighlight lang="cpp">
colorText[] = { IGUI_TEXT_RGB, 1 };
</syntaxhighlight>
== Functions ==
* [[BIS_fnc_displayColorGet]]
* [[BIS_fnc_displayColorSet]]
{{GameCategory|tkoh|Editing}}
[[Category: GUI Topics]]

Latest revision as of 16:09, 12 August 2023

Take On Helicopters introduced ability to recolor menu and HUD colors. Community creators can define new presets or use user's colors using following configs and functions.

Presets

Interface Colors menu

Presets are available for users in Options > Game Options > Interface Colors menu. Anybody can define new presets and categories. 

class CfgUIDefault // In Arma 3 the class was renamed to CfgUIColors
{
	// --- Tag
	class IGUI
	{
		// --- Name displayed in menu
		displayName = "$STR_HSIM_CfgUIDefault_IGUI_0";
		// --- Color variables
		class Variables
		{
			// --- Identification class ised by presets and scripts
			class TEXT_RGB
			{
				// --- Name displayed in menu
				displayName = "$STR_HSIM_CfgUIDefault_IGUI_Variables_TEXT_RGB_0";
				// --- Preview picture background
				previewBackground = "\hsim\UI_H\data\loadscreen_generic_co.paa";
				// --- Preview picture (when 1 instead of String, whole menu is recolored instead)
				preview = "\hsim\UI_H\data\cursor_w_view_gs.paa";
				// --- Preview picture width
				previewW = 4 * GUI_GRID_W;
				// --- Preview picture height
				previewH = 4 * GUI_GRID_H;
			};
		};
		// --- Color presets
		class Presets
		{
			class PresetDefault
			{
				// --- Name displayed in menu
				displayName = "$STR_HSIM_CfgUIDefault_IGUI_Presets_PresetGreen_0";
				// --- Class of modified variable (TEXT_RGB) with RGBA values
				TEXT_RGB[] = {0,1,0.05,0.8};
				// --- When 1, preset is used as default
				default = 1;
			};
			class PresetBlue
			{
				displayName = "$STR_HSIM_CfgUIDefault_IGUI_Presets_PresetDefault_0";
				TEXT_RGB[] = {0,1,1,0.8};
			};
		};
	};
};

Macros

Adding New

System stores preset variables into profileNamespace upon startup. UI controls can link to them using getVariable command.

Using macros helps to keep the code simple and maintain it through development. 

#define IGUI_TEXT_RGB_R	"(profileNamespace getVariable ['IGUI_TEXT_RGB_R', 0])"
#define IGUI_TEXT_RGB_G	"(profileNamespace getVariable ['IGUI_TEXT_RGB_G', 1])"
#define IGUI_TEXT_RGB_B	"(profileNamespace getVariable ['IGUI_TEXT_RGB_B', 0.05])"
#define IGUI_TEXT_RGB_A	"(profileNamespace getVariable ['IGUI_TEXT_RGB_A', 0.8])"

Explanation:

  • #define IGUI_TEXT_RGB_R - macro name. Can be anything, but naming it based on preset is recommended.
  • "(profileNamespace getVariable ['IGUI_TEXT_RGB_R',0])" - actual value. Must be String, otherwise macro would be terminated after first comma (,)
    • IGUI_TEXT_RGB - variable created by system based on preset. Created from <tag>_<variable>
    • 0 - default value in case variable is not found (used on first game start)

Existing

Color macros are defined in defineCommon.inc (see User Interface Macros for more details). Following defines are based on user modifiable colors:

  • GUI (menus)
    • 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
  • IGUI (HUD)
    • IGUI_TEXT_RGB - HUD color RGB
    • IGUI_TEXT_COLOR - HUD color RGBA

Sample Configs

Set text/picture color to HUD color 

colorText[] = IGUI_TEXT_COLOR;

Set text/picture color to HUD color with fixed alpha (e.g. override user transparency settings) 

colorText[] = { IGUI_TEXT_RGB, 1 };


Functions

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