upstream/wesnoth
1
0
Fork 0
mirror of https://github.com/wesnoth/wesnoth synced 2025-04-25 11:23:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

[LuaDoc] Instead of marking unit fields optional, define to_map and to_recall as taking WML as an alternative to a unit

Browse Source
This commit is contained in:
Celtic Minstrel 2024-02-08 09:49:16 -05:00
parent 6145c48d35
commit d885687380
1 changed files with 50 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

100
utils/emmylua/wesnoth/units.lua
View File

@ -57,53 +57,53 @@
---Defines an individual unit
---@class unit : wesnoth.units, location
---@field valid "'map'"|"'recall'"|"'private'"|nil
---@field loc? location
---@field id? string
---@field loc location
---@field id string
---@field side integer
---@field type string
---@field variation? string
---@field gender? "'male'"|"'female'"
---@field race? string
---@field portrait? string
---@field image_mods? string
---@field ellipse? string
---@field halo? string
---@field hidden? boolean
---@field name? tstring
---@field description? tstring
---@field facing? direction
---@field overlays? string[]
---@field hitpoints? integer
---@field max_hitpoints? integer
---@field experience? integer
---@field max_experience? integer
---@field moves? integer
---@field max_moves? integer
---@field attacks_left? integer
---@field max_attacks? integer
---@field level? integer
---@field recall_cost? integer
---@field cost? integer
---@field canrecruit? boolean
---@field zoc? boolean
---@field alignment? string
---@field upkeep? integer|"'full'"|"'free'"|"'loyal'"
---@field usage? string
---@field renamable? boolean
---@field undead_variation? string
---@field role? string
---@field resting? boolean
---@field recall_filter? WML
---@field extra_recruit? string[]
---@field advances_to? string[]
---@field advancements? WMLTable[]
---@field status? table<string, boolean>
---@field variables? WMLVariableProxy
---@field attacks? unit_weapon[]
---@field traits? string[]
---@field abilities? string[]
---@field animations? string[]
---@field __cfg? WMLTable
---@field variation string
---@field gender "'male'"|"'female'"
---@field race string
---@field portrait string
---@field image_mods string
---@field ellipse string
---@field halo string
---@field hidden boolean
---@field name tstring
---@field description tstring
---@field facing direction
---@field overlays string[]
---@field hitpoints integer
---@field max_hitpoints integer
---@field experience integer
---@field max_experience integer
---@field moves integer
---@field max_moves integer
---@field attacks_left integer
---@field max_attacks integer
---@field level integer
---@field recall_cost integer
---@field cost integer
---@field canrecruit boolean
---@field zoc boolean
---@field alignment string
---@field upkeep integer|"'full'"|"'free'"|"'loyal'"
---@field usage string
---@field renamable boolean
---@field undead_variation string
---@field role string
---@field resting boolean
---@field recall_filter WML
---@field extra_recruit string[]
---@field advances_to string[]
---@field advancements WMLTable[]
---@field status table<string, boolean>
---@field variables WMLVariableProxy
---@field attacks unit_weapon[]
---@field traits string[]
---@field abilities string[]
---@field animations string[]
---@field __cfg WMLTable
---@class wesnoth.units
wesnoth.units = {}
@ -135,16 +135,16 @@ function wesnoth.units.extract(unit) end
function wesnoth.units.matches(unit, filter, context) end
---Place or move a unit on the map
---@param unit unit
---@param unit unit|WML
---@param loc? location
---@param fire_event? boolean
---@overload fun(unit:unit, x:integer, y:integer)
---@overload fun(unit:unit, x:integer, y:integer, fire_event:boolean)
---@overload fun(unit:unit, fire_event:boolean)
---@overload fun(unit:unit|WML, x:integer, y:integer)
---@overload fun(unit:unit|WML, x:integer, y:integer, fire_event:boolean)
---@overload fun(unit:unit|WML, fire_event:boolean)
function wesnoth.units.to_map(unit, loc, fire_event) end
---Place a unit on a recall lists
---@param unit unit
---@param unit unit|WML
---@param side? integer
function wesnoth.units.to_recall(unit, side) end