WordList

← Back to Asset Types

Documentation for the WordList asset type.

Location

WordLists

Use in Your Files

Add this to your JSON files for IDE autocompletion and validation:

"$schema": "https://hytaledb.ginco.gg/schemas/WordList.schema.json" Copy

Schema

Tree

TranslationKeys arraynull

The list of word message keys. Need to be added in Assets/Server/Languages/wordlists.lang. For example if the WordList asset file is 'animals' and you write 'cow' here, it will refer to 'animals.cow' (full path is 'wordlists.animals.cow')

Array items: string

All of

base

Raw JSON

Copy

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "WordList.json",
  "title": "WordList",
  "description": "WordList asset type",
  "type": "object",
  "allOf": [
    {
      "$ref": "base.schema.json"
    }
  ],
  "properties": {
    "TranslationKeys": {
      "type": [
        "array",
        "null"
      ],
      "description": "The list of word message keys. Need to be added in Assets/Server/Languages/wordlists.lang. For example if the WordList asset file is 'animals' and you write 'cow' here, it will refer to 'animals.cow' (full path is 'wordlists.animals.cow')",
      "items": {
        "type": "string"
      }
    }
  }
}