Skip to content

Update notes: Release 20200202 to Release 20200503

Paul Chote edited this page May 3, 2020 · 1 revision

The following compatibility changes have been made between release-20200202 and release-20200503. Some of these changes will require manual actions on your part before you can run the semi-automated mod updater.

UI Changes

Significant changes to the UI artwork and chrome yaml have been made, primarily to support the new UI scale option. If your mod inherits the UI (including chrome.yaml) from one of the base mods you will need to compare your mod.yaml with the base mod and potentially change the following:

  • The LoadScreen definition now includes Image2x and Image3x to specify higher resolution artwork. [#17581]
  • The new mainmenu-prompts.yaml file should be referenced in ChromeLayout. [#17622]

If you define your own chrome.yaml with UI artwork definitions, major changes are required. The file format has been overhauled, and will be automatically updated when you run the mod updater. After updating, you will need to manually adjust your artwork and the chrome regions as described in #17494 to avoid rendering glitches. The new --debug-chrome-regions utility command can be used to visualize the region mappings (see #17489 for more details). New Image2x and Image3x definitions should be added to specify higher resolution artwork where appropriate.

If your mod defines its own sidebar or observer UI you will need to adapt the changes from #16709, #17696, #17490 to your chrome/ingame*.yaml files.

If your mod does not include chrome layout directly from the common|chrome or cnc|chrome directories (which we strongly recommend) you will need to review the change history for cnc/chrome and common/chrome between 2019-12-11 and 2020-02-22 and update your definitions as appropriate.

If your mod does not include the chrome metrics directly from common|metrics.yaml you will need to review #17511, #17586, #17633 and update your definitions as appropriate.

If your mod does not include hotkey definitions directly from common|hotkeys/*.yaml you will need to review #17424, #17482, #16709, #17490] and update your definitions as appropriate.

Moved SupportedFormats from chrome yaml to mod.yaml

Custom assets browser chrome logic defining SupportedFormats needs to be adapted. SupportedFormats was renamed to SupportedExtensions and moved to the AssetBrowser section in mod.yaml. [#17539]

Rule changes:

  • New EditorCursorLayer and EditorActionManager traits should be added to the EditorWorld actor definition. [#17509, #16772]
  • A new PlayerRadarTerrain trait should be added to the Player actor definition. [#17076]