AchievementType¶

Overview¶

A AchievementType config contains data about one of the many achievements in the game.

These config types can be found within the config.Achievement table:

config.Achievement.CHEEVO_GODWARS_SOULSTONES
config.Achievement["CHEEVO_GODWARS_SOULSTONES"]
config.Achievement.FromID(1618) -- config.Achievement.CHEEVO_GODWARS_SOULSTONES

Information available within an AchievementType includes:

• Display name
• Rewards
• Prerequisites
• Requirements

Examples¶

-- Access a AchievementType config directly by using its name
local cheevocfg = config.Achievement.CHEEVO_GODWARS_SOULSTONES
-- or by ID lookup
local cheevocfg = config.Achievement.FromID(id.Achievement.CHEEVO_GODWARS_SOULSTONES)

Prerequisites and Requirements¶

Achievement configs contain one or more tests, each which can be one of several different test types:

These test types are further split into two different collections:

An example would be an achievement with:

• Prerequisite
  • Skill Test - Smithing >= 20
• Requirement
  • Crafted Tally - Crafting items that require at least level 20 in Smithing to craft

This example could hide the achievement until Smithing is at level 20, revealing it only when the Player Character is able to craft items that meet the requirement.

More information about each of the types of test is shown below.

AchievementTestSkill¶

This test collects Player Character's levels in the given SkillTypes into one cumulative total, and compares it against the target total level.

Typically this test will contain only one skill, but is able to support more.

AchievementTestQuest¶

This test checks whether the Player Character has completed the given quest.

AchievementTestAchievement¶

This test checks whether the Player Character has completed the given achievement.

AchievementTestVarTotal¶

This test checks whether the cumulative total of a given list of VarPlayers values meets or exceeds a given total value.

An example would be a test for '50 bosses killed' that accumulates the values of many separate VarPlayers which individually track kills for a specific boss.

A more basic example would be '20 oak logs chopped' where only one VarPlayer value is compared to the total.

AchievementTestVarTestBit¶

This test checks whether a specific bit in a VarPlayer value matches a given value of 0 or 1.

Enumerations¶

AchievementProgressType¶

Achievement progress is provided by the AchievementType.progress property.

A positive value indicates that the achievement has partial completion, while a 0 or negative value indicates one of the enumerations below.

AchievementDescriptionType¶

Alternate achievement descriptions are available for various game modes.

These types are provided along with the relevant string by the AcheivementType.descriptions property.

AchievementHiddenType¶

An achievement's display behaviour is controlled by this enumeration, and is provided by the AchievementType.hiddenType property.

Constructors¶

Methods¶

GetPrereqGroupComplete¶

function Achievement:GetPrereqGroupComplete(group : Integer) -> Boolean

Returns whether the given prerequisite group is considered complete.

Depending on the value of GetSubItemCompletionCountForPrereqGroup(), this can mean all or only some of the individual prerequisites have actually been completed.

local cfg = config.Achievement.LEAGUE_TASK_EQUIP_MASTERWORK_ARMOUR_SET
-- Check how many prerequisite groups are completed
local totalGroupsCompleted = 0

-- 3 groups of prerequisites in this config
for i=1,cfg.prereqGroupCount do
    local groupIsCompleted = cfg:GetPrereqGroupComplete(i - 1) -- Group starts at 0
    if groupIsCompleted then
        totalGroupsCompleted = totalGroupsCompleted + 1
    end
end

-- Set if prereqs are considered to be completed
local prereqsAreCompleted = totalGroupsCompleted >= cfg.completionCountForPrereqGroups

-- The above can also be achieved with only
local prereqsAreCompleted = cfg.prereqsComplete

GetSubItemCompletionCountForPrereqGroup¶

function Achievement:GetSubItemCompletionCountForPrereqGroup(group : Integer) -> Boolean

Returns how many individual prerequisites, each with the same group, must be completed for that group to be considered complete.

For example, if there were three prerequisites with group 0, and GetSubItemCompletionCountForPrereqGroup(0) returned a value of 1, then only one of the three prerequisites will need to be completed.

local cfg = config.Achievement.LEAGUE_TASK_EQUIP_MASTERWORK_ARMOUR_SET

-- Gather how many prereqs of group 0 are completed
local totalCompleted = 0;
local testGroup = 0;

-- Loop through all types of prereq
for k,v in pairs(cfg.prereqs) do
    -- k will be 'skills', 'quests', 'achievements', 'varTotals' or 'varTestBits'
    -- v will be a list of all the prereqs of that type
    for _,req in ipairs(v) do
        if req.group == testGroup and req.isComplete then
            totalCompleted = totalCompleted + 1
        end
    end
end

-- How many of group 0 must be completed
local completeNeeded = cfg:GetSubItemCompletionCountForPrereqGroup(0)

-- Set if the group has been completed
local groupIsCompleted = totalCompleted >= completeNeeded

-- The above can also be achieved with only
local groupIsCompleted = cfg:GetPrereqGroupComplete(0)

GetSubItemCompletionCountForRequirementGroup¶

function Achievement:GetSubItemCompletionCountForRequirementGroup(group : Integer) -> Boolean

Returns how many individual requirements, each with the same group, must be completed for that group to be considered complete.

For example, if there were three requirements with group 0, and GetSubItemCompletionCountForRequirementGroup(0) returned a value of 1, then only one of the three requirements will need to be completed.

local cfg = config.Achievement.CHEEVO_MENAPHOS_SLAYER_MOBS_I

-- Gather how many requirements of group 0 are completed
local totalCompleted = 0;
local testGroup = 0;

-- Loop through all types of prereq
for k,v in pairs(cfg.requirements) do
    -- k will be 'skills', 'quests', 'achievements', 'varTotals' or 'varTestBits'
    -- v will be a list of all the requirements of that type
    for _,req in ipairs(v) do
        if req.group == testGroup and req.isComplete then
            totalCompleted = totalCompleted + 1
        end
    end
end

-- How many of group 0 must be completed
local completeNeeded = cfg:GetSubItemCompletionCountForRequirementGroup(0)

-- Set if the group has been completed
local groupIsCompleted = totalCompleted >= completeNeeded

Properties¶