[extra-field / экстра-поля] Систематизация документации

night_dragon_on · October 30, 2016

Экстра поля, первоначально доступные в панелях команд, постепенно перетекли в настройки всех основных элементов мода таких как:

+ экран загрузки боя;
+ панели игроков ("уши");
+ окно статистики (Tab);
+ миникарта;
+ маркеры техники;
+ пользовательские текстовые поля в окне боевого интерфейса.

Вся документация о доступных настройках в полях и описание к ним разбросано по разным файлам. Предложение таково - создать единый файл с описанием всех доступных к использования параметров, который будет располагаться в директории с остальной документацией по модификации XVM, т.е. в:

res_mods\mods\shared_resources\xvm\doc

Черновик:

'extra-field.txt'

Extra field parameters available:

Legend:
  BL  - battle loading screen
  PP  - players panel
  SF  - statistic form (Tab)
  MM  - minimap
  VM  - vehicle markers
  BLb - custom labels on battle interface window

  'X' - available
  ' ' - not available (can return wrong value - '', 'NaN', 'undefined', ...)
  '.' - TODO
  '-' - Obsoleted (will be replaced with other macro)

  Set of formats fields available for configuring (default value applyed, when parameter is not defined).

┌───────────────────┬───┬───┬───┬───┬───┬───┬─────────────────────────────────────────────────
│ Parameters:       │ BL│ PP│ SF│ MM│ VM│BLb│ Description:
├───────────────────┼───┼───┼───┼───┼───┼───┼─────────────────────────────────────────────────
│ "enabled"         │ X │ X │ X │ X │ X │ X │ enable/disable field creation: true or false (default: false)
├───────────────────┼───┼───┼───┼───┼───┼───┼─────────────────────────────────────────────────
│ "x"               │ X │ X │ X │ X │ X │ X │ X position (macros allowed) (default: 0)
├───────────────────┼───┼───┼───┼───┼───┼───┼─────────────────────────────────────────────────
│ "y"               │ X │ X │ X │ X │ X │ X │ Y position (macros allowed) (default: 0)
├───────────────────┼───┼───┼───┼───┼───┼───┼─────────────────────────────────────────────────
│ "width"           │ X │ X │ X │ X │ X │ X │ width (macros allowed) (default: 0)
├───────────────────┼───┼───┼───┼───┼───┼───┼─────────────────────────────────────────────────
│ "height"          │ X │ X │ X │ X │ X │ X │ height (macros allowed) (default: 0)
├───────────────────┼───┼───┼───┼───┼───┼───┼─────────────────────────────────────────────────
│ "bindToIcon"      │ X │ X │ X │   │   │   │ if enabled, X position is binded to vehicle icon (default: false)
├───────────────────┼───┼───┼───┼───┼───┼───┼─────────────────────────────────────────────────
│ "alpha"           │ X │ X │ X │ X │ X │ X │ transparency in percents (0..100) (macros allowed) (default: 100)
├───────────────────┼───┼───┼───┼───┼───┼───┼─────────────────────────────────────────────────
│ "rotation"        │ X │ X │ X │ X │ X │ X │ rotation in degrees (0..360) (macros allowed) (default: 0)
├───────────────────┼───┼───┼───┼───┼───┼───┼─────────────────────────────────────────────────
│ "align"           │ X │ X │ X │ X │ X │ X │ horizontal alignment of the field relative to its position ("left" [default], "center", "right")
├───────────────────┼───┼───┼───┼───┼───┼───┼─────────────────────────────────────────────────
│ "valign"          │ X │ X │ X │ X │ X │ X │ vertical alignment of the field relative to its position ("top" [default], "center", "bottom")
├───────────────────┼───┼───┼───┼───┼───┼───┼─────────────────────────────────────────────────
│ "scaleX"          │ X │ X │ X │ X │ X │ X │ scaling axis X in % (use negative values for mirroring) (default: 1)
├───────────────────┼───┼───┼───┼───┼───┼───┼─────────────────────────────────────────────────
│ "scaleY"          │ X │ X │ X │ X │ X │ X │ scaling axis Y in % (use negative values for mirroring) (default: 1)
├───────────────────┼───┼───┼───┼───┼───┼───┼─────────────────────────────────────────────────
│ "hotKeyCode"      │ X │ X │ X │ X │ X │ X │ keyboard key code (see list in hotkeys.xc), when pressed - switches text field to show and apply configured html in "format", or hide;
│                   │   │   │   │   │   │   │ when defined, text field will not be shown until key is pressed, to disable define null value or delete parameter
├───────────────────┼───┼───┼───┼───┼───┼───┼─────────────────────────────────────────────────
│ "onHold"          │ X │ X │ X │ X │ X │ X │ false - take action by key click; true - while key is remains pressed (default: false)
├───────────────────┼───┼───┼───┼───┼───┼───┼─────────────────────────────────────────────────
│ "visibleOnHotKey" │ X │ X │ X │ X │ X │ X │ true - field visible on hot key pressed; false - vice versa (default: true)
├───────────────────┼───┼───┼───┼───┼───┼───┼─────────────────────────────────────────────────
│ "flags"           │   │   │   │   │   │ X │ field visibility flag:
│                   │   │   │   │   │   │   │ "flags": [ "player", "ally", "squadman", "enemy", "teamKiller", "neverSeen", "lost", "spotted", "alive", "dead" ],
│                   │   │   │   │   │   │   │
│                   │   │   │   │   │   │   │ if don't set "ally", "squadman", "player", "enemy", "teamKiller", they are not used.
│                   │   │   │   │   │   │   │ if don't set "neverSeen", "lost" and "spotted", it uses all - and "neverSeen", and "lost", and "spotted". Note: "neverSeen" status disabled for the minimap.
│                   │   │   │   │   │   │   │ if don't set "alive", "dead", it uses both - and "alive", and "dead".
├───────────────────┼───┼───┼───┼───┼───┼───┼─────────────────────────────────────────────────
│ "borderColor"     │ X │ X │ X │ X │ X │ X │ if set, draw border with specified color (macros allowed) (default: null)
├───────────────────┼───┼───┼───┼───┼───┼───┼─────────────────────────────────────────────────
│ "bgColor"         │ X │ X │ X │ X │ X │ X │ if set, draw background with specified color (macros allowed) (default: null)
├───────────────────┼───┼───┼───┼───┼───┼───┼─────────────────────────────────────────────────
│ "antiAliasType"   │ X │ X │ X │ X │ X │ X │ sets anti-aliasing to advanced anti-aliasing ("advanced" [default] or "normal")
├───────────────────┼───┼───┼───┼───┼───┼───┼─────────────────────────────────────────────────
│ "highlight"       │   │ X │   │   │   │   │ highlight icon depending on the player state (default: false)
├───────────────────┼───┼───┼───┼───┼───┼───┼─────────────────────────────────────────────────
│ "layer"           │ X │ X │ X │ X │ X │   │ field Z-order
│                   │   │   │   │   │   │   │
│                   │   │   │   │   │   │   │ values:
│                   │   │   │   │   │   │   │ "substrate": put field behind all fields (for the players panel x value depends on the players panel width)
│                   │   │   │   │   │   │   │ "bottom": put field behind all standard fields but above substrate fields (for the players panel x value does not depend on the players panel width)
│                   │   │   │   │   │   │   │ "normal": put field above bottom fields (for the players panel etc- above vehicle icon but behind standard text fields) (default)
│                   │   │   │   │   │   │   │ "top": put field above all fields
├───────────────────┼───┼───┼───┼───┼───┼───┼─────────────────────────────────────────────────
│ "src"             │ X │ X │ X │ X │ X │ X │ display image ("xvm://res/contour/{{vehiclename}}.png")
├───────────────────┼───┼───┼───┼───┼───┼───┼─────────────────────────────────────────────────
│ "shadow"          │ X │ X │ X │ X │ X │ X │ shadow settings, defaults:
│                   │   │   │   │   │   │   │ "shadow": { "enabled": true, "distance": 0, "angle": 0, "color": "0x000000", "alpha": 75, "blur": 2, "strength": 1 }
│                   │   │   │   │   │   │   │
│                   │   │   │   │   │   │   │ values:
│                   │   │   │   │   │   │   │ "distance"   - distance shadow, in pixels (default: 0)
│                   │   │   │   │   │   │   │ "angle"      - angle shadow (0.0 .. 360.0) (default: 0)
│                   │   │   │   │   │   │   │ "color"      - color shadow ("0xXXXXXX") (default: "0x000000")
│                   │   │   │   │   │   │   │ "alpha"      - shadow alpha (0 .. 100) (default: 75)
│                   │   │   │   │   │   │   │ "blur"       - blur shadow (0.0 .. 255.0) (default: 2)
│                   │   │   │   │   │   │   │ "strength"   - strength shadow (0.0 .. 255.0) (default: 1)
│                   │   │   │   │   │   │   │ "hideObject" - indicates whether or not the object is hidden. The value true indicates that the object itself is not drawn; only the shadow is visible. The default is false (the object is shown).
│                   │   │   │   │   │   │   │ "inner"      - indicates whether or not the shadow is an inner shadow. The value true indicates an inner shadow. The default is false, an outer shadow (a shadow around the outer edges of the object).
│                   │   │   │   │   │   │   │ "knockout"   - applies a knockout effect (true), which effectively makes the object's fill transparent and reveals the background color of the document. The default is false (no knockout).
│                   │   │   │   │   │   │   │ "quality"    - the number of times to apply the filter. The default value is 1 (applying the filter once). Although you can use additional numeric values up to 15 to achieve different effects, higher values are rendered more SLOWLY.
│                   │   │   │   │   │   │   │
│                   │   │   │   │   │   │   │ http://help.adobe.com/en_US/FlashPlatform/reference/actionscript/3/flash/filters/DropShadowFilter.html
├───────────────────┼───┼───┼───┼───┼───┼───┼─────────────────────────────────────────────────
│ "textFormat"      │ X │ X │ X │ X │ X │ X │ it applies global style to HTML in "format"; note, that defined font attributes in "format" override those in "textFormat"
│                   │   │   │   │   │   │   │ field default styles, defaults:
│                   │   │   │   │   │   │   │ "textFormat": { "font": "$FieldFont", "color": "0xFFFFFF", "size": 12, "align": "left", "valign": "top", "bold": false, "italic": false, "underline": false, "display": "block", "leading": 0, "marginLeft": 0, "marginRight": 0 }
│                   │   │   │   │   │   │   │
│                   │   │   │   │   │   │   │ values:
│                   │   │   │   │   │   │   │ "font"        - font name (default: "$FieldFont")
│                   │   │   │   │   │   │   │ "color"       - font color ("0xXXXXXX") (default: "0xFFFFFF")
│                   │   │   │   │   │   │   │ "size"        - font size (default: 12)
│                   │   │   │   │   │   │   │ "align"       - horizontal alignment of the text inside the field (left [default], center, right)
│                   │   │   │   │   │   │   │ "valign"      - vertical alignment of the text inside the field ("top" [default], "center", "bottom")
│                   │   │   │   │   │   │   │ "bold"        - true - bold (default: false)
│                   │   │   │   │   │   │   │ "italic"      - true - italic (default: false)
│                   │   │   │   │   │   │   │ "underline"   - true - underline (default: false)
│                   │   │   │   │   │   │   │ "display"     - defines how element must be showed (inline, block [default], none)
│                   │   │   │   │   │   │   │ "leading"     - space between lines, similarly (<textformat leading='-XX'>...</textformat>) (default: 0)
│                   │   │   │   │   │   │   │ "marginLeft"  - indent left, similarly (<textformat lefMargin='XX'>...</textformat>) (default: 0)
│                   │   │   │   │   │   │   │ "marginRight" - indent right, similarly (<textformat rightMargin='XX'>...</textformat>) (default: 0)
│                   │   │   │   │   │   │   │
│                   │   │   │   │   │   │   │ http://help.adobe.com/en_US/FlashPlatform/reference/actionscript/3/flash/text/TextFormat.html
├───────────────────┼───┼───┼───┼───┼───┼───┼─────────────────────────────────────────────────
│ "format"          │ X │ X │ X │ X │ X │ X │ displayed text field data (HTML allowed, macros allowed) (default: "")
├───────────────────┼───┼───┼───┼───┼───┼───┼─────────────────────────────────────────────────
│ "updateEvent"     │   │   │   │   │   │ X │ events on which field updates, use with dynamic macros; to disable define null value or delete parameter;
│                   │   │   │   │   │   │   │ multiple events separated by comma
│                   │   │   │   │   │   │   │
│                   │   │   │   │   │   │   │ allowed events:
│                   │   │   │   │   │   │   │ ON_BATTLE_STATE_CHANGED
│                   │   │   │   │   │   │   │ ON_PLAYERS_HP_CHANGED
│                   │   │   │   │   │   │   │ ON_VEHICLE_DESTROYED
│                   │   │   │   │   │   │   │ ON_CURRENT_VEHICLE_DESTROYED
│                   │   │   │   │   │   │   │ ON_MODULE_CRITICAL
│                   │   │   │   │   │   │   │ ON_MODULE_DESTROYED
│                   │   │   │   │   │   │   │ ON_MODULE_REPAIRED
│                   │   │   │   │   │   │   │ ON_DAMAGE_CAUSED
│                   │   │   │   │   │   │   │ ON_DAMAGE_CAUSED_ALLY
│                   │   │   │   │   │   │   │ ON_TARGET_IN                 - aim at the vehicle
│                   │   │   │   │   │   │   │ ON_TARGET_OUT                - aim not at the vehicle
│                   │   │   │   │   │   │   │ ON_PANEL_MODE_CHANGED
│                   │   │   │   │   │   │   │ ON_EVERY_FRAME               * can reduce performance
│                   │   │   │   │   │   │   │ ON_EVERY_SECOND              * can reduce performance
│                   │   │   │   │   │   │   │ PY(event_name)               - event from python, sent by as_event(event_name)
├───────────────────┼───┼───┼───┼───┼───┼───┼─────────────────────────────────────────────────
│ "mouseEvents"     │   │   │   │   │   │ X │ the events handlers must be binded using the function as_callback(event_name)
│                   │   │   │   │   │   │   │
│                   │   │   │   │   │   │   │ allowed events:
│                   │   │   │   │   │   │   │ "click"      - event is sent when the mouse button clicked inside the field
│                   │   │   │   │   │   │   │ "mouseDown"  - event is sent when the mouse button pressed inside the field
│                   │   │   │   │   │   │   │ "mouseUp"    - event is sent when the mouse button released inside the field
│                   │   │   │   │   │   │   │ "mouseOver"  - event is sent when the mouse pointer enters the field
│                   │   │   │   │   │   │   │ "mouseOut"   - event is sent when the mouse pointer leaves the field
│                   │   │   │   │   │   │   │ "mouseMove"  - event is sent when mouse pointer moves inside the field
│                   │   │   │   │   │   │   │ "mouseWheel" - event is sent when mouse wheel rolled inside the field
├───────────────────┼───┼───┼───┼───┼───┼───┼─────────────────────────────────────────────────
│ "screenHAlign"    │   │   │   │   │   │ X │ horizontal alignment of the field on the screen ("left" [default], "center", "right")
├───────────────────┼───┼───┼───┼───┼───┼───┼─────────────────────────────────────────────────
│ "screenVAlign"    │   │   │   │   │   │ X │ vertical alignment of the field on the screen ("top" [default], "center", "bottom")
└───────────────────┴───┴───┴───┴───┴───┴───┴─────────────────────────────────────────────────

'extra-field_ru.txt'

Доступные параметры экстра полей:

Legend:
  BL  - экран загрузки боя
  PP  - панели игроков ("уши")
  SF  - окно статистики (Tab)
  MM  - миникарта
  VM  - маркеры техники
  BLb - пользовательские текстовые поля в окне боевого интерфейса

  'X' - доступен
  ' ' - не доступен (может возвращать неверные данные - '', 'NaN', 'undefined', ...)
  '.' - TODO (запланировано)
  '-' - устаревший (будет заменён другим макросом)

  Набор форматов полей доступных для настройки (значение по-умолчанию применяется, если параметр не указан).

┌───────────────────┬───┬───┬───┬───┬───┬───┬─────────────────────────────────────────────────
│ Параметры:        │ BL│ PP│ SF│ MM│ VM│BLb│ Описание:
├───────────────────┼───┼───┼───┼───┼───┼───┼─────────────────────────────────────────────────
│ "enabled"         │ X │ X │ X │ X │ X │ X │ включить/отключить создание полей: true or false (по-умолчанию: false)
├───────────────────┼───┼───┼───┼───┼───┼───┼─────────────────────────────────────────────────
│ "x"               │ X │ X │ X │ X │ X │ X │ положение по оси X (доступно использование макросов) (по-умолчанию: 0)
├───────────────────┼───┼───┼───┼───┼───┼───┼─────────────────────────────────────────────────
│ "y"               │ X │ X │ X │ X │ X │ X │ положение по оси Y (доступно использование макросов) (по-умолчанию: 0)
├───────────────────┼───┼───┼───┼───┼───┼───┼─────────────────────────────────────────────────
│ "width"           │ X │ X │ X │ X │ X │ X │ ширина элемента (доступно использование макросов) (по-умолчанию: 0)
├───────────────────┼───┼───┼───┼───┼───┼───┼─────────────────────────────────────────────────
│ "height"          │ X │ X │ X │ X │ X │ X │ высота элемента (доступно использование макросов) (по-умолчанию: 0)
├───────────────────┼───┼───┼───┼───┼───┼───┼─────────────────────────────────────────────────
│ "bindToIcon"      │ X │ X │ X │   │   │   │ если функция включена, то положение элемента по оси X отстраивается от координат иконки техники (default: false)
├───────────────────┼───┼───┼───┼───┼───┼───┼─────────────────────────────────────────────────
│ "alpha"           │ X │ X │ X │ X │ X │ X │ прозрачность элемента, в процентах (0..100) (доступно использование макросов) (по-умолчанию: 100)
├───────────────────┼───┼───┼───┼───┼───┼───┼─────────────────────────────────────────────────
│ "rotation"        │ X │ X │ X │ X │ X │ X │ поворот элемента, в градусах (доступно использование макросов) (по-умолчанию: 0)
├───────────────────┼───┼───┼───┼───┼───┼───┼─────────────────────────────────────────────────
│ "align"           │ X │ X │ X │ X │ X │ X │ горизонтальное выравнивание текстового поля относительно его позиции ("left" [по-умолчанию], "center", "right")
├───────────────────┼───┼───┼───┼───┼───┼───┼─────────────────────────────────────────────────
│ "valign"          │ X │ X │ X │ X │ X │ X │ вертикальное выравнивание текстового поля относительно его позиции ("top" [по-умолчанию], "center", "bottom")
├───────────────────┼───┼───┼───┼───┼───┼───┼─────────────────────────────────────────────────
│ "scaleX"          │ X │ X │ X │ X │ X │ X │ масштабирование по оси X в % (используйте отрицательные значения для зеркального отображения) (по-умолчанию: 1)
├───────────────────┼───┼───┼───┼───┼───┼───┼─────────────────────────────────────────────────
│ "scaleY"          │ X │ X │ X │ X │ X │ X │ масштабирование по оси Y в % (используйте отрицательные значения для зеркального отображения) (по-умолчанию: 1)
├───────────────────┼───┼───┼───┼───┼───┼───┼─────────────────────────────────────────────────
│ "hotKeyCode"      │ X │ X │ X │ X │ X │ X │ горячие клавиши клавиатуры (список в hotkeys.xc), при нажатии - выводится текстовое поле и применяются параметры html в "format", или скрывается поле;
│                   │   │   │   │   │   │   │ текстовое поле не будет отображаться, пока не будет нажата клавиша, для отключения используйте значение null или удалите параметр;
├───────────────────┼───┼───┼───┼───┼───┼───┼─────────────────────────────────────────────────
│ "onHold"          │ X │ X │ X │ X │ X │ X │ false - производит действие по разовому нажатию клавиши; true - по удержанию (по-умолчанию: false)
├───────────────────┼───┼───┼───┼───┼───┼───┼─────────────────────────────────────────────────
│ "visibleOnHotKey" │ X │ X │ X │ X │ X │ X │ true - поле отображается при нажатии горячей клавиши; false - наоборот (по-умолчанию: true)
├───────────────────┼───┼───┼───┼───┼───┼───┼─────────────────────────────────────────────────
│ "flags"           │   │   │   │   │   │ X │ флаг видимости поля:
│                   │   │   │   │   │   │   │ "flags": [ "player", "ally", "squadman", "enemy", "teamKiller", "neverSeen", "lost", "spotted", "alive", "dead" ],
│                   │   │   │   │   │   │   │
│                   │   │   │   │   │   │   │ если не указаны "ally", "squadman", "player", "enemy", "teamKiller", то они не используются.
│                   │   │   │   │   │   │   │ если не указаны "neverSeen", "lost" и "spotted", то используются все - и "neverSeen", и "lost", и "spotted". Примечание: статус "neverSeen" для миникарты отключен.
│                   │   │   │   │   │   │   │ если не указаны "alive", "dead", то используются оба - и "alive", и "dead".
├───────────────────┼───┼───┼───┼───┼───┼───┼─────────────────────────────────────────────────
│ "borderColor"     │ X │ X │ X │ X │ X │ X │ окрашивает границу в заданный цвет, если установлен (доступно использование макросов) (по-умолчанию: null)
├───────────────────┼───┼───┼───┼───┼───┼───┼─────────────────────────────────────────────────
│ "bgColor"         │ X │ X │ X │ X │ X │ X │ окрашивает фон в заданный цвет, если установлен (доступно использование макросов) (по-умолчанию: null)
├───────────────────┼───┼───┼───┼───┼───┼───┼─────────────────────────────────────────────────
│ "antiAliasType"   │ X │ X │ X │ X │ X │ X │ задает использование расширенных возможностей сглаживания ("advanced" [по-умолчанию] or "normal")
├───────────────────┼───┼───┼───┼───┼───┼───┼─────────────────────────────────────────────────
│ "highlight"       │   │ X │   │   │   │   │ веделение иконки в зависимости от состояния игрока (по-умолчанию: false)
├───────────────────┼───┼───┼───┼───┼───┼───┼─────────────────────────────────────────────────
│ "layer"           │ X │ X │ X │ X │ X │   │ порядок расположения полей по оси Z
│                   │   │   │   │   │   │   │
│                   │   │   │   │   │   │   │ значения:
│                   │   │   │   │   │   │   │ "substrate": расположить поле позади всех имеющихся полей
│                   │   │   │   │   │   │   │ "bottom": расположить поле позади всех стандартных полей, но выше полей подложки
│                   │   │   │   │   │   │   │ "normal": расположить поле выше нижних полей
│                   │   │   │   │   │   │   │ "top": расположить поле над всеми имеющимися полями
├───────────────────┼───┼───┼───┼───┼───┼───┼─────────────────────────────────────────────────
│ "src"             │ X │ X │ X │ X │ X │ X │ отображение изображения ("xvm://res/contour/{{vehiclename}}.png")
├───────────────────┼───┼───┼───┼───┼───┼───┼─────────────────────────────────────────────────
│ "shadow"          │ X │ X │ X │ X │ X │ X │ настройки тени, значение по умолчанию:
│                   │   │   │   │   │   │   │ "shadow": { "enabled": true, "distance": 0, "angle": 0, "color": "0x000000", "alpha": 75, "blur": 2, "strength": 1 }
│                   │   │   │   │   │   │   │
│                   │   │   │   │   │   │   │ значения:
│                   │   │   │   │   │   │   │ "distance"   - дистанция тени, в пикселях (по-умолчанию: 0)
│                   │   │   │   │   │   │   │ "angle"      - угол смещения тени, в градусах (по-умолчанию: 0)
│                   │   │   │   │   │   │   │ "color"      - цвет тени ("0xXXXXXX") (по-умолчанию: "0x000000")
│                   │   │   │   │   │   │   │ "alpha"      - прозрачность тени (0 .. 100) (по-умолчанию: 75)
│                   │   │   │   │   │   │   │ "blur"       - эффект размывки тени (0.0 .. 255.0) (по-умолчанию: 2)
│                   │   │   │   │   │   │   │ "strength"   - интенсивность тени (0.0 .. 255.0) (по-умолчанию: 1)
│                   │   │   │   │   │   │   │ "hideObject" - определяет, является ли объект скрытым. Значение true указывает на то, что сам объект не нарисован, видна только его тень. Значение по умолчанию — false (объект отображается).
│                   │   │   │   │   │   │   │ "inner"      - определяет, является ли тень внутренней тенью. Значение true указывает на наличие внутренней тени. Значение по умолчанию false задает внешнюю тень (тень вокруг внешнего контура объекта).
│                   │   │   │   │   │   │   │ "knockout"   - применяет эффект выбивки (true), который фактически делает заливку объекта прозрачной и выявляет цвет фона документа. Значение по умолчанию — false (без выбивки).
│                   │   │   │   │   │   │   │ "quality"    - заданное число применений фильтра. Значение по умолчанию — 1 (однократное применение фильтра). Можно использовать дополнительные числовые значения до 15 для получения разнообразных эффектов, более высокие значения выполняются ДОЛЬШЕ.
│                   │   │   │   │   │   │   │
│                   │   │   │   │   │   │   │ http://help.adobe.com/en_US/FlashPlatform/reference/actionscript/3/flash/filters/DropShadowFilter.html
├───────────────────┼───┼───┼───┼───┼───┼───┼─────────────────────────────────────────────────
│ "textFormat"      │ X │ X │ X │ X │ X │ X │ применяет глобальный стиль HTML в "format"; обратите внимание, что определенные атрибуты шрифта в "format" переопределяют "textFormat"
│                   │   │   │   │   │   │   │ стандартный стиль поля, значение по умолчанию:
│                   │   │   │   │   │   │   │ "textFormat": { "font": "$FieldFont", "color": "0xFFFFFF", "size": 12, "align": "left", "valign": "top", "bold": false, "italic": false, "underline": false, "display": "block", "leading": 0, "marginLeft": 0, "marginRight": 0 }
│                   │   │   │   │   │   │   │
│                   │   │   │   │   │   │   │ значения:
│                   │   │   │   │   │   │   │ "font"        - наименование шрифта (по-умолчанию: "$FieldFont")
│                   │   │   │   │   │   │   │ "color"       - цвет шрифта ("0xXXXXXX") (по-умолчанию: "0xFFFFFF")
│                   │   │   │   │   │   │   │ "size"        - размер шрифта (по-умолчанию: 12)
│                   │   │   │   │   │   │   │ "align"       - горизонтальное выравнивание текста текста внутри поля (left [по-умолчанию], center, right)
│                   │   │   │   │   │   │   │ "valign"      - вертикальное выравнивание текста внутри поля ("none" [по-умолчанию], "top", "center", "bottom")
│                   │   │   │   │   │   │   │ "bold"        - true - жирный (по-умолчанию: false)
│                   │   │   │   │   │   │   │ "italic"      - true - курсив (по-умолчанию: false)
│                   │   │   │   │   │   │   │ "underline"   - true - подчеркивание (по-умолчанию: false)
│                   │   │   │   │   │   │   │ "display"     - указывает как именно элемент должен быть показан (inline, block [по-умолчанию], none)
│                   │   │   │   │   │   │   │ "leading"     - пространство между строками, аналогично (<textformat leading='-XX'>...</textformat>) (по-умолчанию: 0)
│                   │   │   │   │   │   │   │ "marginLeft"  - отступ слева, аналогично (<textformat lefMargin='XX'>...</textformat>) (по-умолчанию: 0)
│                   │   │   │   │   │   │   │ "marginRight" - отступ справа, аналогично (<textformat rightMargin='XX'>...</textformat>) (по-умолчанию: 0)
│                   │   │   │   │   │   │   │
│                   │   │   │   │   │   │   │ http://help.adobe.com/en_US/FlashPlatform/reference/actionscript/3/flash/text/TextFormat.html
├───────────────────┼───┼───┼───┼───┼───┼───┼─────────────────────────────────────────────────
│ "format"          │ X │ X │ X │ X │ X │ X │ отображаемые данные в текстовых полях (доступно использование HTML и макросов) (по-умолчанию: "")
├───────────────────┼───┼───┼───┼───┼───┼───┼─────────────────────────────────────────────────
│ "updateEvent"     │   │   │   │   │   │ X │ события по которому обновляется поле, используйте динамические макросы; для отключения используйте значение null или удалите параметр;
│                   │   │   │   │   │   │   │ несколько событий разделяются запятой
│                   │   │   │   │   │   │   │
│                   │   │   │   │   │   │   │ доступные события:
│                   │   │   │   │   │   │   │ ON_BATTLE_STATE_CHANGED
│                   │   │   │   │   │   │   │ ON_PLAYERS_HP_CHANGED
│                   │   │   │   │   │   │   │ ON_VEHICLE_DESTROYED
│                   │   │   │   │   │   │   │ ON_CURRENT_VEHICLE_DESTROYED
│                   │   │   │   │   │   │   │ ON_MODULE_CRITICAL
│                   │   │   │   │   │   │   │ ON_MODULE_DESTROYED
│                   │   │   │   │   │   │   │ ON_MODULE_REPAIRED
│                   │   │   │   │   │   │   │ ON_DAMAGE_CAUSED
│                   │   │   │   │   │   │   │ ON_DAMAGE_CAUSED_ALLY
│                   │   │   │   │   │   │   │ ON_TARGET_IN                 - aim at the vehicle
│                   │   │   │   │   │   │   │ ON_TARGET_OUT                - aim not at the vehicle
│                   │   │   │   │   │   │   │ ON_PANEL_MODE_CHANGED
│                   │   │   │   │   │   │   │ ON_EVERY_FRAME               * can reduce performance
│                   │   │   │   │   │   │   │ ON_EVERY_SECOND              * can reduce performance
│                   │   │   │   │   │   │   │ PY(event_name)               - event from python, sent by as_event(event_name)
├───────────────────┼───┼───┼───┼───┼───┼───┼─────────────────────────────────────────────────
│ "mouseEvents"     │   │   │   │   │   │ X │ обработчики событий должны быть привязаны с помощью функции as_callback(event_name)
│                   │   │   │   │   │   │   │
│                   │   │   │   │   │   │   │ доступные события:
│                   │   │   │   │   │   │   │ "click"      - событие отправляется при клике мышкой внутри поля
│                   │   │   │   │   │   │   │ "mouseDown"  - событие отправляется при нажатии кнопки мышки внутри поля
│                   │   │   │   │   │   │   │ "mouseUp"    - событие отправляется при отжатии кнопки мышки внутри поля
│                   │   │   │   │   │   │   │ "mouseOver"  - событие отправляется при перемещении курсора мыши на поле
│                   │   │   │   │   │   │   │ "mouseOut"   - событие отправляется при перемещении курсора мыши из поля
│                   │   │   │   │   │   │   │ "mouseMove"  - событие отправляется при перемещении курсора мыши внутри поля
│                   │   │   │   │   │   │   │ "mouseWheel" - событие отправляется при прокручивании колеса мыши внутри поля
├───────────────────┼───┼───┼───┼───┼───┼───┼─────────────────────────────────────────────────
│ "screenHAlign"    │   │   │   │   │   │ X │ горизонтальное выравнивание поля на экране ("left" [по-умолчанию], "center", "right")
├───────────────────┼───┼───┼───┼───┼───┼───┼─────────────────────────────────────────────────
│ "screenVAlign"    │   │   │   │   │   │ X │ вертикальное выравнивание поля на экране ("top" [по-умолчанию], "center", "bottom")
└───────────────────┴───┴───┴───┴───┴───┴───┴─────────────────────────────────────────────────

Задачи:

+ ~~Подлатать описание~~.

+ ~~Упорядочить параметры и описание к ним~~:

- общие параметры;

- частные параметры используемые только в конкретных элементах;

- алфавитном порядке и т.п.

+ ~~Дать нормальное описание к доступным значениям для параметра "layer" на русском~~ (думаю @sirmax лучше опишет).

+ ~~Заполнить поля где возможно использовать те или иные параметры в полях~~.

Edited November 4, 2016 by night_dragon_on

sirmax · October 30, 2016

Очень давно напрашивалось, огромное спасибо, что взялся. Черновики - ок.

night_dragon_on · November 4, 2016

Очень давно напрашивалось, огромное спасибо, что взялся. Черновики - ок.

@sirmax, нужен перевод для описания:

"layer": field Z-order

values:
"substrate": put field behind all fields (for the players panel x value depends on the players panel width)
"bottom": put field behind all standard fields but above substrate fields (for the players panel x value does not depend on the players panel width)
"normal": put field above bottom fields (for the players panel etc- above vehicle icon but behind standard text fields) (default)
"top": put field above all fields

Из первых уст, мой не совсем полный и корректный.

Edited November 4, 2016 by night_dragon_on

sirmax · November 4, 2016

@sirmax, нужен перевод для описания:

"layer": field Z-order

values:
"substrate": put field behind all fields (for the players panel x value depends on the players panel width)
"bottom": put field behind all standard fields but above substrate fields (for the players panel x value does not depend on the players panel width)
"normal": put field above bottom fields (for the players panel etc- above vehicle icon but behind standard text fields) (default)
"top": put field above all fields

Из первых уст, мой не совсем полный и корректный.

put field behind all fields (for the players panel x value depends on the players panel width)

Поместить поле под всеми полями (для ушей значение x ЗАВИСИТ от ширины ушей)

"bottom": put field behind all standard fields but above substrate fields (for the players panel x value does not depend on the players panel width)

Поместить поле под всеми стандартными полями (для ушей значение x НЕ ЗАВИСИТ от ширины ушей)

"normal": put field above bottom fields (for the players panel - above vehicle icon but behind standard text fields) (default)

Поместить поле над "bottom" (для ушей над иконкой танка, но под стандартными текстовыми полями)

"top": put field above all fields

Поместить поле над всеми полями

night_dragon_on · November 4, 2016

Дополнил. Вроде бы нормально вышло.

В списке изменений будем запись делать?

P.S.:

Нужны ли в текущих реалиях тестовые поля "test" и "test2" в battleLabelsTemplates.xc, там уже достаточно примеров приведено.

Edited November 4, 2016 by night_dragon_on

sirmax · November 4, 2016

Можно написать об изменениях, хуже не будет.

Тест можно убрать, хотя я в своем конфиге их использую, но я переделаю, не страшно.

night_dragon_on · November 4, 2016

Можно написать об изменениях, хуже не будет.

Добавил запись.

Тему закрываю, цель обсуждения достигнута.

Если есть какие либо предложения по дополнению описания, обсудим в теме:

Предложения по стандартному конфигу / Suggestions for default config

Edited November 4, 2016 by night_dragon_on

Sign In

[extra-field / экстра-поля] Систематизация документации

Recommended Posts

night_dragon_on

Link to comment

Short link

Share on other sites

sirmax

Link to comment

Short link

Share on other sites

night_dragon_on

Link to comment

Short link

Share on other sites

sirmax

Link to comment

Short link

Share on other sites

night_dragon_on

Link to comment

Short link

Share on other sites

sirmax

Link to comment

Short link

Share on other sites

night_dragon_on

Link to comment

Short link

Share on other sites

Recently Browsing 0 members