Add LuaCATS documentation for UI and UIManager (LoneGazebo#11654)

* Add LuaCATS for UI, and other.

* Add LuaCATS for UIManager

* Make pseudo types aliases instead of classes.

Author: vaderkos

LuaCATS/City.d.lua

@@ -0,0 +1,8 @@
+--- @meta
+
+--- @class City
+local City = {}
+
+--- Gets city owner player id.
+--- @return PlayerId
+function City:GetOwner() end

LuaCATS/Context.d.lua

@@ -0,0 +1,3 @@
+--- @meta
+
+--- @class Context

LuaCATS/Control.d.lua

@@ -0,0 +1,3 @@
+--- @meta
+
+--- @class Control : Context

LuaCATS/Deal.d.lua

@@ -0,0 +1,4 @@
+--- @meta
+
+--- @class Deal
+local Deal = {}

LuaCATS/Global.d.lua

@@ -5,6 +5,17 @@
 --- for more information
 --- @see require
 --- @param filename string # Filename to load, or regex to load files
---- @param useRegex? boolean # 
+--- @param useRegex? boolean #
 --- @return nil | string[]
-function include(filename, useRegex) end
+function include(filename, useRegex) end
+
+--- TODO docs
+--- @param vector2 { x: number, y: number }
+--- @return integer #
+function ToHexFromGrid(vector2) end
+
+--- TODO docs
+--- @param x integer
+--- @param y integer
+--- @return integer, integer #
+function ToGridFromHex(x, y) end

LuaCATS/Locale.d.lua

@@ -98,16 +98,16 @@ function Locale.ToNumber(num, format) end
 --- @class SpokenLanguage: Language
 --- @field Path string
 
---- ```lua 
+--- ```lua
 --- -- Example
---- Locale.GetCurrentLanguage() -- { Type = 'en_US', DisplayName = 'English' } 
+--- Locale.GetCurrentLanguage() -- { Type = 'en_US', DisplayName = 'English' }
 --- ```
 --- @return { Type: string, DisplayName: string }
 function Locale.GetCurrentLanguage() end
 
---- ```lua 
+--- ```lua
 --- -- Example
---- Locale.GetCurrentSpokenLanguage() -- { Type = 'en_US', Path = 'English', DisplayName = 'English' } 
+--- Locale.GetCurrentSpokenLanguage() -- { Type = 'en_US', Path = 'English', DisplayName = 'English' }
 --- ```
 --- @return SpokenLanguage
 function Locale.GetCurrentSpokenLanguage() end
@@ -153,15 +153,15 @@ function Locale.IsASCII(str) end
 --- @return boolean
 function Locale.IsUTF8(str) end
 
---- ```lua 
+--- ```lua
 --- -- Example
 --- Locale.ConvertPosixTimeToString(0) -- "1970-01-01 01:00"
 --- ```
 --- @param time number
 --- @return string
 function Locale.ConvertPosixTimeToString(time) end
 
---- ```lua 
+--- ```lua
 --- -- Example
 --- Locale.IsNilOrEmpty('') -- true
 --- Locale.IsNilOrEmpty(nil) -- true
@@ -173,7 +173,7 @@ function Locale.IsNilOrEmpty(str) end
 
 --- Checks if `str` consists of whitespaces or is `nil`.
 --- <b> Do not use this function to check strings like `"[NEWLINE]"`, `"[SPACE]"` etc. </b>
---- ```lua 
+--- ```lua
 --- -- Example
 --- Locale.IsNilOrWhitespace('') -- true
 --- Locale.IsNilOrWhitespace(nil) -- true
@@ -195,10 +195,10 @@ function Locale.IsNilOrWhitespace(str) end
 function Locale.Substring(str, startIndex, endIndex) end
 
 --- Converts `num` to curreny string depending on current language.
---- ```lua 
+--- ```lua
 --- -- Example
 --- -- if current language is en_US
---- Locale.ToCurrency(123) -- '$123.00' 
+--- Locale.ToCurrency(123) -- '$123.00'
 --- Locale.ToCurrency(123.256) -- '$123.26'
 --- -- if current language is pl_PL
 --- Locale.ToCurrency(123) -- '123,00 zł'
@@ -208,7 +208,7 @@ function Locale.Substring(str, startIndex, endIndex) end
 function Locale.ToCurrency(num) end
 
 --- Converts `num` to ordinal string depending on current language
---- ```lua 
+--- ```lua
 --- -- Example
 --- -- if current language is en_US
 --- Locale.ToOrdinal(1) -- "1ˢᵗ"
@@ -224,7 +224,7 @@ function Locale.ToCurrency(num) end
 function Locale.ToOrdinal(num) end
 
 --- Convers `num` to percent, where `1` is `"100%"`. Expect different result depending on current language
---- ```lua 
+--- ```lua
 --- -- Example
 --- -- if current language is en_US
 --- Locale.ToPercent(1) -- "100%"
@@ -246,15 +246,15 @@ function Locale.ToPercent(num) end
 --- Locale.ToSpellout(1) -- "one"
 --- Locale.ToSpellout(-555.12) -- "minus five hundred fifty-five point one two"
 --- Locale.ToSpellout(5/0) -- "eighteen quadrillion..." very long number, looks like something like max number
---- -- if current language is pl_PL 
+--- -- if current language is pl_PL
 --- Locale.ToSpellout(555) -- "pięćset pięćdziesiąt pięć"
 --- ```
 --- @param num number
 --- @return string
 function Locale.ToSpellout(num) end
 
---- Converts specified `num` to roman numeral string. 
---- It is limited by some maximum number after which 
+--- Converts specified `num` to roman numeral string.
+--- It is limited by some maximum number after which
 --- just converts number to current language representation
 --- ```lua
 --- -- Example
@@ -268,10 +268,10 @@ function Locale.ToRomanNumeral(num) end
 
 --- Unknown behaviour
 --- @deprecated
---- @param ... any
+--- @param ... unknown
 function Locale.LocalSystemCPToUTF8(...) end
 
 --- Unknown behaviour
 --- @deprecated
---- @param ... any
+--- @param ... unknown
 function Locale.UTF8ToLocalSystemCP(...) end

LuaCATS/Player.d.lua

@@ -0,0 +1,8 @@
+--- @meta
+
+--- @class Player
+local Player = {}
+
+--- Gets player ID
+--- @return PlayerId
+function Player:GetId() end

LuaCATS/Plot.d.lua

@@ -0,0 +1,121 @@
+--- @meta
+
+--- @class Plot
+local Plot = {}
+
+--- TODO docs
+--- @return integer
+--- @nodiscard
+function Plot:GetX() end
+
+--- TODO docs
+--- @return integer
+--- @nodiscard
+function Plot:GetY() end
+
+--- Gets plot owner id
+--- @return PlayerId
+--- @nodiscard
+function Plot:GetOwner() end
+
+--- TODO docs
+--- @return AreaId
+--- @nodiscard
+function Plot:GetArea() end
+
+--- TODO docs
+--- @return TeamId
+--- @nodiscard
+function Plot:GetTeam() end
+
+--- Gets the number of units stationed in specified plot.
+--- @return integer
+--- @nodiscard
+function Plot:GetNumUnits() end
+
+--- Determines the amount of culture yielded by working the plot.
+--- @return number
+--- @nodiscard
+function Plot:GetCulture() end
+
+--- TOOD docs
+--- @return boolean
+--- @nodiscard
+function Plot:IsCity() end
+
+--- TODO docs
+--- @return City | nil
+--- @nodiscard
+function Plot:GetPlotCity() end
+
+--- TODO docs
+--- @return boolean
+--- @nodiscard
+function Plot:IsWater() end
+
+--- TODO docs
+--- @return boolean
+--- @nodiscard
+function Plot:IsRiver() end
+
+--- TODO docs
+--- @return boolean
+--- @nodiscard
+function Plot:IsLake() end
+
+--- TODO docs
+--- @return boolean
+--- @nodiscard
+function Plot:IsHills() end
+
+--- TODO docs
+--- @return boolean
+--- @nodiscard
+function Plot:IsOwned() end
+
+--- TODO docs
+--- @return boolean
+--- @nodiscard
+function Plot:IsMountain() end
+
+--- TODO docs
+--- @return boolean
+--- @nodiscard
+function Plot:IsFreshWater() end
+
+--- TODO docs
+--- @return boolean
+--- @nodiscard
+function Plot:IsFlatlands() end
+
+--- TODO docs
+--- @return boolean
+--- @nodiscard
+function Plot:IsCoastalLand() end
+
+--- TODO docs
+--- @return boolean
+--- @nodiscard
+function Plot:IsRoutePillaged() end
+
+--- TODO docs
+--- @return boolean
+--- @nodiscard
+function Plot:IsImprovementEmbassy() end
+
+--- TODO docs
+--- @return boolean
+--- @nodiscard
+function Plot:IsImprovementPillaged() end
+
+--- TODO docs
+--- @return boolean
+--- @nodiscard
+function Plot:IsImpassable() end
+
+--- Checks if plot is revealed by specified team.
+--- @param teamId TeamId
+--- @param debug boolean
+--- @return boolean
+--- @nodiscard
+function Plot:IsRevealed(teamId, debug) end

LuaCATS/Pseudo.d.lua

@@ -0,0 +1,8 @@
+--- @meta
+
+--- @alias PlayerId integer
+--- @alias AreaId integer
+--- @alias CityId integer
+--- @alias PlotId integer
+--- @alias TeamId integer
+--- @alias UnitId integer