-
Notifications
You must be signed in to change notification settings - Fork 7
/
_achievement.lua
37 lines (33 loc) · 1.82 KB
/
_achievement.lua
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
---@meta
---@class achievement
---@field ID MQInt # The achivement's unique ID
---@field Name MQString # The achievement's name
---@field Description MQString # The achievement's description
---@field Points MQInt # The point value for the achievement
---@field ObjectiveCount MQInt # The number of objectives in this achievement
---@field Index MQInt # The index of the achivement. See [Achivement Indices](https://docs.macroquest.org/reference/top-level-objects/tlo-achievement/#note-about-achievement-indices) for more information.
---@field IconID MQInt # ID of the Achievement state. See [Achivement Icon](https://docs.macroquest.org/reference/data-types/datatype-achievement/#achievement-icon) for more information.
---@field State MQString # The achievement state. See [Achievement State](https://docs.macroquest.org/reference/data-types/datatype-achievement/#achievement-state) for more information.
---@field Completed MQBoolean # If the achievement has been completed
---@field Open MQBoolean # If the achievement is open
---@field Locked MQBoolean # If the achievement is locked
---@field Hidden MQBoolean # If the achievement is hidden
local achievement = {}
---@diagnostic disable: duplicate-set-field
---Find an objective by it's Description
---@param description string
---@return achievementobj
function achievement.Objective(description) end
---Find an objective by it's Id
---@param id integer
---@return achievementobj
function achievement.Objective(id) end
---@diagnostic enable: duplicate-set-field
---Generate an cheivement link. An optional name can be
---provided to display in the achievement, otherwise the
---current character's name will be used.
---@param name? string
---@return string
function achievement.Link(name) end
---@return time # Calendar time when the achievement was completed.
function achievement.CompletedTime() end