From cea4f58fb683a1ea27c23e88eacf96955cadd47b Mon Sep 17 00:00:00 2001 From: Joshua Fehler Date: Sun, 13 Oct 2024 18:57:38 -0400 Subject: [PATCH] docs: Cleanup AchievementEncEntry docs --- .../05-encentry-features/07-ach-entry.rst | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/docs/user_guide/05-encentry-features/07-ach-entry.rst b/docs/user_guide/05-encentry-features/07-ach-entry.rst index 05a493c..9fc6ac3 100644 --- a/docs/user_guide/05-encentry-features/07-ach-entry.rst +++ b/docs/user_guide/05-encentry-features/07-ach-entry.rst @@ -9,19 +9,28 @@ This is **not** a replacement for Ren'Py's achievement system. It only allows you to manage the state of an EncEntry using an Achievement's status. +.. note:: AchievementEncEntry does not emit the "unlocked" event. + +.. note:: AchievementEncEntry does not cause the parent Encyclopaedia to emit the "entry_unlocked" event. + + .. code-block:: python - achievement.register("read_all_the_books") + achievement_read_all_books = "read_all_books" + + achievement.register(achievement_read_all_books) + + reader_encyclopaedia = Encyclopaedia() read_all_the_books_entry = AchievementEncEntry( - achievement="read_all_the_books", - parent=your_new_encyclopaedia, + achievement=achievement_read_all_books, + parent=reader_encyclopaedia, name="Looks Like We Got Ourselves A Reader", text="Read all the books." ) >>> read_all_the_books_entry.locked == True - achievement.grant("read_all_the_books") + achievement.grant(achievement_read_all_books) >>> read_all_the_books_entry.locked == False