ModUI: Difference between revisions

From The Colonists
Jump to navigation Jump to search
placeholder for change to globalStorageUISpec
swap resourceCategoriesDict to globalStorageUISpec
Line 11: Line 11:
| building [[Building| ID]]
| building [[Building| ID]]
| Defines '''order''', not the [[BuildingCatModIds|'''menu''']], of [[Building|buildings]] in the building selection (bottom right)
| Defines '''order''', not the [[BuildingCatModIds|'''menu''']], of [[Building|buildings]] in the building selection (bottom right)
|-
| techCategoryOrderIds
| Tech [[ResearchCatModIds| category]]
| Defines order of [[Research|research]] category panels in research window
|-
| globalStorageUISpec
| category<br>entries
| Defines order and grouping of resources in lower left menu
|-
| '''OBSOLETE'''
| '''OBSOLETE'''
| '''OBSOLETE'''
|-
|-
| resourceCategoriesDict
| resourceCategoriesDict
| id<br>itemTypeId<br>itemCategory
| id<br>itemTypeId<br>itemCategory
| Defines [[ResourceCatModIds|'''grouping''']], [[Resource_Categories|'''categorisation''']], and order of [[Resource|resources]] show in the bottom left menu<br>id should be unique from other resources in this file<br>itemTypeId matches the value of typeId in resources.json
| Defines [[ResourceCatModIds|'''grouping''']], [[Resource_Categories|'''categorisation''']], and order of [[Resource|resources]] show in the bottom left menu<br>id should be unique from other resources in this file<br>itemTypeId matches the value of typeId in resources.json
|-
| techCategoryOrderIds
| Tech [[ResearchCatModIds| category]]
| Defines order of [[Research|research]] category panels in research window
|-
|-
|}
|}
* note itemCategory is used when itemTypeId=254 to refer to a [[Resource_Categories|category]] (e.g. "Food", "Luxury Food", "Fuel"), otherwise itemCategory=0.
* note itemCategory is used when itemTypeId=254 to refer to a [[Resource_Categories|category]] (e.g. "Food", "Luxury Food", "Fuel"), otherwise itemCategory=0.<br>
 
* note globalStorageUISpec superceded resourceCategoriesDict. Left in for history.<br>
=Example JSON=
=Example JSON=
<pre>
<pre>

Revision as of 18:05, 11 January 2023

The ui.json file may be used to change the game interface.
pending change. resourceCategoriesDict obsolete and change to globalStorageUISpec.

JSON fields

Name Entry Description
constructionGridBuildingIds building ID Defines order, not the menu, of buildings in the building selection (bottom right)
techCategoryOrderIds Tech category Defines order of research category panels in research window
globalStorageUISpec category
entries
Defines order and grouping of resources in lower left menu
OBSOLETE OBSOLETE OBSOLETE
resourceCategoriesDict id
itemTypeId
itemCategory
Defines grouping, categorisation, and order of resources show in the bottom left menu
id should be unique from other resources in this file
itemTypeId matches the value of typeId in resources.json
  • note itemCategory is used when itemTypeId=254 to refer to a category (e.g. "Food", "Luxury Food", "Fuel"), otherwise itemCategory=0.
  • note globalStorageUISpec superceded resourceCategoriesDict. Left in for history.

Example JSON

{
  "constructionGridBuildingIds": [
    41,
    19,
    38
  ],
  "resourceCategoriesDict": {
    "0": [
      {
        "id": 0,
        "itemTypeId": 43,
        "itemCategory": 0
      },
      {
        "id": 1,
        "itemTypeId": 45,
        "itemCategory": 0
      },
      {
        "id": 2,
        "itemTypeId": 46,
        "itemCategory": 0
      }
    ],
    "1": [
      {
        "id": 9,
        "itemTypeId": 6,
        "itemCategory": 0
      },
      {
        "id": 10,
        "itemTypeId": 2,
        "itemCategory": 0
      }
    ],
    "2": [
      {
        "id": 20,
        "itemTypeId": 12,
        "itemCategory": 0
      },
      {
        "id": 21,
        "itemTypeId": 254, // 254 for item category
        "itemCategory": 2 // item category 2 = simple food
      },
      {
        "id": 24,
        "itemTypeId": 254, // 254 for item category
        "itemCategory": 4 // item category 4 = alcohol
      }
    ]
  }
  "techCategoryOrderIds": [
    0,
    6,
    4,
  ]
}