Difference between revisions of "LuaAPI/wesnoth/achievements"

Revision as of 22:37, 4 February 2023

Achievements

wesnoth.achievements.set

♟ wesnoth.achievements.set(content_for,id)

content_for: The [achievements_group] that this achievement is part of.
id: The id of the achievement.

Sets the specified achievement as completed. Unlike the [set_achievement] tag, this does not display a popup.

wesnoth.achievements.has

♟ wesnoth.achievements.has(content_for,id) → achieved?

content_for: The [achievements_group] that this achievement is part of.
id: The id of the achievement.

Returns whether the specified achievement has been completed.

NOTE: This is not safe to use in online multiplayer since different players can have different achievements completed. As such it will always be treated as if the achievement is not completed.

wesnoth.achievements.get

♟ wesnoth.achievements.get(content_for,id) → cfg

Returns the contents as described for the [achievement] tag, as well as the additional current_progress attribute. If a progressable achievement is completed, current_progress will be -1. If this is not a progressable achievement, then current_progress and max_progress will both be 0.

content_for: The [achievements_group] that this achievement is part of.
id: The id of the achievement.

NOTE: While this can be used to retrieve the achievement's actual achievement status for a client in online multiplayer, this is also not safe to use in that situation for the same reason.

wesnoth.achievements.progress

♟ wesnoth.achievements.progress(content_for,id,[amount,[limit]]) → number

Progresses an achievement by amount up to either the achievement's completion or limit, whichever is smaller, and returns the new current progress of the achievement.

Both limit and amount are optional. If a limit is not provided, then the achievement is allowed to progress until it is completed. If both are omitted, then the achievement is not progressed and it simply returns the current progress of the achievement.

NOTE: The achievement's current progress is not safe to use in online multiplayer for the same reason that wesnoth.achievements.has and wesnoth.achievements.get are unsafe.

@@ Line 29: / Line 29: @@
 * {{LuaGameOnly}} '''wesnoth.achievements.get'''(''content_for'',''id'') → ''cfg''
-Returns the contents of the [[AchievementsWML|[achievement]]] tag.
+Returns the contents as described for the [[AchievementsWML|[achievement]]] tag, as well as the additional '''current_progress''' attribute. If a progressable achievement is completed, '''current_progress''' will be -1. If this is not a progressable achievement, then '''current_progress''' and '''max_progress''' will both be 0.
 * '''content_for''': The [[AchievementsWML|[achievements_group]]] that this achievement is part of.
@@ Line 35: / Line 35: @@
 '''NOTE:''' While this can be used to retrieve the achievement's actual achievement status for a client in online multiplayer, this is also not safe to use in that situation for the same reason.
+=== wesnoth.achievements.progress ===
+* {{LuaGameOnly}} '''wesnoth.achievements.progress'''(''content_for'',''id'',[''amount'',[''limit'']]) → ''number''
+Progresses an achievement by '''amount''' up to either the achievement's completion or '''limit''', whichever is smaller, and returns the new current progress of the achievement.
+Both '''limit''' and '''amount''' are optional. If a '''limit''' is not provided, then the achievement is allowed to progress until it is completed. If both are omitted, then the achievement is not progressed and it simply returns the current progress of the achievement.
+'''NOTE''': The achievement's current progress is not safe to use in online multiplayer for the same reason that '''wesnoth.achievements.has''' and '''wesnoth.achievements.get''' are unsafe.