Arma Reforger Script API
Loading...
Searching...
No Matches
Static Public Member Functions | Static Public Attributes | List of all members
UIConstants Interface Reference

Static Public Member Functions

static string GetActionDisplayStateAttribute (SCR_EActionDisplayState state)
 Convert the action display state to a string for attributes and Rich Text formatting.
 
static string FormatUnitPercentage (float percentage)
 Get formatted percentage string.
 
static string FormatUnitShortPlus (float value)
 Get formatted +x string.
 
static string FormatValueOutOf (float value, float max, bool condensed=true)
 Get formatted x out of y string. Not condensed adds a space in some languages, ie: x / y instead of x/y.
 
static string FormatVersion (string version)
 
static string GetFavoriteLabel (bool isFavorite)
 
static string FormatSeconds (int totalSeconds)
 

Static Public Attributes

static const float FADE_RATE_INSTANT = 0
 
static const float FADE_RATE_SUPER_FAST = 20
 
static const float FADE_RATE_FAST = 10
 
static const float FADE_RATE_DEFAULT = 5
 
static const float FADE_RATE_SLOW = 1
 
static const float FADE_RATE_SUPER_SLOW = 0.2
 
static const float PROCESSING_SPINNER_ANIMATION_SPEED = 0.75
 
static const string FAVORITE_LABEL_ADD = "#AR-Workshop_ButtonAddToFavourites"
 
static const string FAVORITE_LABEL_REMOVE = "#AR-Workshop_ButtonRemoveFavourites"
 
static const string BOHEMIA_INTERACTIVE = "Bohemia Interactive"
 
static const string BOHEMIA_INTERACTIVE_LOC = "#AR-Author_BI"
 
static const string VALUE_UNIT_PERCENTAGE = "#AR-ValueUnit_Percentage"
 
static const string VALUE_UNIT_SHORT_PLUS = "#AR-ValueUnit_Short_Plus"
 
static const string VALUE_OUT_OF = "#AR-SupportStation_ActionFormat_ItemAmount"
 
static const string VALUE_OUT_OF_SPACED = "#AR-Filters_EntriesFound_Condensed"
 
static const string TIME_DISPLAY_DAYS_HOURS_MINUTES_SECONDS = "#AR-TimeDisplay_Days_Hours_Minutes_Seconds"
 
static const string TIME_DISPLAY_HOURS_MINUTES_SECONDS = "#AR-TimeDisplay_Hours_Minutes_Seconds"
 
static const string TIME_DISPLAY_MINUTES_SECONDS = "#AR-TimeDisplay_Minutes_Seconds"
 
static const string TIME_DISPLAY_SECONDS = "#AR-TimeDisplay_Seconds"
 
static const ResourceName ICONS_IMAGE_SET = "{3262679C50EF4F01}UI/Textures/Icons/icons_wrapperUI.imageset"
 
static const ResourceName ICONS_GLOW_IMAGE_SET = "{00FE3DBDFD15227B}UI/Textures/Icons/icons_wrapperUI-glow.imageset"
 
static const string PLATFROM_PC_ICON_NAME = "platform-windows"
 
static const string PLATFROM_XBOX_ICON_NAME = "platform-xbox"
 
static const string PLATFROM_PLAYSTATION_ICON_NAME = "platform-playstation"
 
static const string PLATFROM_GENERIC_ICON_NAME = "generic-platform"
 
static const string ICON_WARNING = "warning"
 
static const string ICON_OK = "okCircle"
 
static const string ICON_CANCEL = "cancelCircle"
 
static const string ICON_CHECK = "check"
 
static const string ICON_NOT_AVAILABLE = "not-available"
 
static const string ACTION_DISPLAY_ICON_SCALE_BIG = "1.25"
 
static const string ACTION_DISPLAY_ICON_SCALE_VERY_BIG = "1.5"
 
static const string ACTION_DISPLAY_ICON_SCALE_HUGE = "1.75"
 
static const float DISABLED_WIDGET_OPACITY = 0.3
 
static const float ENABLED_WIDGET_OPACITY = 1
 
static const float DISABLED_WIDGET_SATURATION = 0.5
 
static const float ENABLED_WIDGET_SATURATION = 1
 
static const string MENU_ACTION_LEFT = "MenuLeft"
 
static const string MENU_ACTION_RIGHT = "MenuRight"
 
static const string MENU_ACTION_UP = "MenuUp"
 
static const string MENU_ACTION_DOWN = "MenuDown"
 
static const string MENU_ACTION_BACK = "MenuBack"
 
static const string MENU_ACTION_MOUSE_WHEEL = "MouseWheel"
 
static const string MENU_ACTION_SELECT = "MenuSelect"
 
static const string MENU_ACTION_SELECT_HOLD = "MenuSelectHold"
 
static const string MENU_ACTION_ENABLE = "MenuEnable"
 
static const string MENU_ACTION_ENABLE_ALL = "MenuEnableAll"
 
static const string MENU_ACTION_DOUBLE_CLICK = "MenuSelectDouble"
 
static const string MENU_ACTION_FAVORITE = "MenuFavourite"
 
static const string MENU_ACTION_OPEN = "MenuOpen"
 
static const string MENU_ACTION_OPEN_WB = "MenuOpenWB"
 
static const string MENU_ACTION_BACK_WB = "MenuBackWB"
 
static const string DEVICE_KEYBOARD = "keyboard"
 
static const string DEVICE_GAMEPAD = "gamepad"
 
static const int MOUSE_LEFT_CLICK = 0
 
static const int MOUSE_RIGHT_CLICK = 1
 
static const string BUTTON_BACK = "Back"
 

Member Function Documentation

◆ FormatSeconds()

static string UIConstants.FormatSeconds ( int  totalSeconds)
static

◆ FormatUnitPercentage()

static string UIConstants.FormatUnitPercentage ( float  percentage)
static

Get formatted percentage string.

◆ FormatUnitShortPlus()

static string UIConstants.FormatUnitShortPlus ( float  value)
static

Get formatted +x string.

◆ FormatValueOutOf()

static string UIConstants.FormatValueOutOf ( float  value,
float  max,
bool  condensed = true 
)
static

Get formatted x out of y string. Not condensed adds a space in some languages, ie: x / y instead of x/y.

◆ FormatVersion()

static string UIConstants.FormatVersion ( string  version)
static

◆ GetActionDisplayStateAttribute()

static string UIConstants.GetActionDisplayStateAttribute ( SCR_EActionDisplayState  state)
static

Convert the action display state to a string for attributes and Rich Text formatting.

◆ GetFavoriteLabel()

static string UIConstants.GetFavoriteLabel ( bool  isFavorite)
static

Member Data Documentation

◆ ACTION_DISPLAY_ICON_SCALE_BIG

const string UIConstants.ACTION_DISPLAY_ICON_SCALE_BIG = "1.25"
static

◆ ACTION_DISPLAY_ICON_SCALE_HUGE

const string UIConstants.ACTION_DISPLAY_ICON_SCALE_HUGE = "1.75"
static

◆ ACTION_DISPLAY_ICON_SCALE_VERY_BIG

const string UIConstants.ACTION_DISPLAY_ICON_SCALE_VERY_BIG = "1.5"
static

◆ BOHEMIA_INTERACTIVE

const string UIConstants.BOHEMIA_INTERACTIVE = "Bohemia Interactive"
static

◆ BOHEMIA_INTERACTIVE_LOC

const string UIConstants.BOHEMIA_INTERACTIVE_LOC = "#AR-Author_BI"
static

◆ BUTTON_BACK

const string UIConstants.BUTTON_BACK = "Back"
static

◆ DEVICE_GAMEPAD

const string UIConstants.DEVICE_GAMEPAD = "gamepad"
static

◆ DEVICE_KEYBOARD

const string UIConstants.DEVICE_KEYBOARD = "keyboard"
static

◆ DISABLED_WIDGET_OPACITY

const float UIConstants.DISABLED_WIDGET_OPACITY = 0.3
static

◆ DISABLED_WIDGET_SATURATION

const float UIConstants.DISABLED_WIDGET_SATURATION = 0.5
static

◆ ENABLED_WIDGET_OPACITY

const float UIConstants.ENABLED_WIDGET_OPACITY = 1
static

◆ ENABLED_WIDGET_SATURATION

const float UIConstants.ENABLED_WIDGET_SATURATION = 1
static

◆ FADE_RATE_DEFAULT

const float UIConstants.FADE_RATE_DEFAULT = 5
static

◆ FADE_RATE_FAST

const float UIConstants.FADE_RATE_FAST = 10
static

◆ FADE_RATE_INSTANT

const float UIConstants.FADE_RATE_INSTANT = 0
static

◆ FADE_RATE_SLOW

const float UIConstants.FADE_RATE_SLOW = 1
static

◆ FADE_RATE_SUPER_FAST

const float UIConstants.FADE_RATE_SUPER_FAST = 20
static

◆ FADE_RATE_SUPER_SLOW

const float UIConstants.FADE_RATE_SUPER_SLOW = 0.2
static

◆ FAVORITE_LABEL_ADD

const string UIConstants.FAVORITE_LABEL_ADD = "#AR-Workshop_ButtonAddToFavourites"
static

◆ FAVORITE_LABEL_REMOVE

const string UIConstants.FAVORITE_LABEL_REMOVE = "#AR-Workshop_ButtonRemoveFavourites"
static

◆ ICON_CANCEL

const string UIConstants.ICON_CANCEL = "cancelCircle"
static

◆ ICON_CHECK

const string UIConstants.ICON_CHECK = "check"
static

◆ ICON_NOT_AVAILABLE

const string UIConstants.ICON_NOT_AVAILABLE = "not-available"
static

◆ ICON_OK

const string UIConstants.ICON_OK = "okCircle"
static

◆ ICON_WARNING

const string UIConstants.ICON_WARNING = "warning"
static

◆ ICONS_GLOW_IMAGE_SET

const ResourceName UIConstants.ICONS_GLOW_IMAGE_SET = "{00FE3DBDFD15227B}UI/Textures/Icons/icons_wrapperUI-glow.imageset"
static

◆ ICONS_IMAGE_SET

const ResourceName UIConstants.ICONS_IMAGE_SET = "{3262679C50EF4F01}UI/Textures/Icons/icons_wrapperUI.imageset"
static

◆ MENU_ACTION_BACK

const string UIConstants.MENU_ACTION_BACK = "MenuBack"
static

◆ MENU_ACTION_BACK_WB

const string UIConstants.MENU_ACTION_BACK_WB = "MenuBackWB"
static

◆ MENU_ACTION_DOUBLE_CLICK

const string UIConstants.MENU_ACTION_DOUBLE_CLICK = "MenuSelectDouble"
static

◆ MENU_ACTION_DOWN

const string UIConstants.MENU_ACTION_DOWN = "MenuDown"
static

◆ MENU_ACTION_ENABLE

const string UIConstants.MENU_ACTION_ENABLE = "MenuEnable"
static

◆ MENU_ACTION_ENABLE_ALL

const string UIConstants.MENU_ACTION_ENABLE_ALL = "MenuEnableAll"
static

◆ MENU_ACTION_FAVORITE

const string UIConstants.MENU_ACTION_FAVORITE = "MenuFavourite"
static

◆ MENU_ACTION_LEFT

const string UIConstants.MENU_ACTION_LEFT = "MenuLeft"
static

◆ MENU_ACTION_MOUSE_WHEEL

const string UIConstants.MENU_ACTION_MOUSE_WHEEL = "MouseWheel"
static

◆ MENU_ACTION_OPEN

const string UIConstants.MENU_ACTION_OPEN = "MenuOpen"
static

◆ MENU_ACTION_OPEN_WB

const string UIConstants.MENU_ACTION_OPEN_WB = "MenuOpenWB"
static

◆ MENU_ACTION_RIGHT

const string UIConstants.MENU_ACTION_RIGHT = "MenuRight"
static

◆ MENU_ACTION_SELECT

const string UIConstants.MENU_ACTION_SELECT = "MenuSelect"
static

◆ MENU_ACTION_SELECT_HOLD

const string UIConstants.MENU_ACTION_SELECT_HOLD = "MenuSelectHold"
static

◆ MENU_ACTION_UP

const string UIConstants.MENU_ACTION_UP = "MenuUp"
static

◆ MOUSE_LEFT_CLICK

const int UIConstants.MOUSE_LEFT_CLICK = 0
static

◆ MOUSE_RIGHT_CLICK

const int UIConstants.MOUSE_RIGHT_CLICK = 1
static

◆ PLATFROM_GENERIC_ICON_NAME

const string UIConstants.PLATFROM_GENERIC_ICON_NAME = "generic-platform"
static

◆ PLATFROM_PC_ICON_NAME

const string UIConstants.PLATFROM_PC_ICON_NAME = "platform-windows"
static

◆ PLATFROM_PLAYSTATION_ICON_NAME

const string UIConstants.PLATFROM_PLAYSTATION_ICON_NAME = "platform-playstation"
static

◆ PLATFROM_XBOX_ICON_NAME

const string UIConstants.PLATFROM_XBOX_ICON_NAME = "platform-xbox"
static

◆ PROCESSING_SPINNER_ANIMATION_SPEED

const float UIConstants.PROCESSING_SPINNER_ANIMATION_SPEED = 0.75
static

◆ TIME_DISPLAY_DAYS_HOURS_MINUTES_SECONDS

const string UIConstants.TIME_DISPLAY_DAYS_HOURS_MINUTES_SECONDS = "#AR-TimeDisplay_Days_Hours_Minutes_Seconds"
static

◆ TIME_DISPLAY_HOURS_MINUTES_SECONDS

const string UIConstants.TIME_DISPLAY_HOURS_MINUTES_SECONDS = "#AR-TimeDisplay_Hours_Minutes_Seconds"
static

◆ TIME_DISPLAY_MINUTES_SECONDS

const string UIConstants.TIME_DISPLAY_MINUTES_SECONDS = "#AR-TimeDisplay_Minutes_Seconds"
static

◆ TIME_DISPLAY_SECONDS

const string UIConstants.TIME_DISPLAY_SECONDS = "#AR-TimeDisplay_Seconds"
static

◆ VALUE_OUT_OF

const string UIConstants.VALUE_OUT_OF = "#AR-SupportStation_ActionFormat_ItemAmount"
static

◆ VALUE_OUT_OF_SPACED

const string UIConstants.VALUE_OUT_OF_SPACED = "#AR-Filters_EntriesFound_Condensed"
static

◆ VALUE_UNIT_PERCENTAGE

const string UIConstants.VALUE_UNIT_PERCENTAGE = "#AR-ValueUnit_Percentage"
static

◆ VALUE_UNIT_SHORT_PLUS

const string UIConstants.VALUE_UNIT_SHORT_PLUS = "#AR-ValueUnit_Short_Plus"
static
The documentation for this interface was generated from the following file:
Generated by doxygen 1.9.6