AchievementEncEntry¶

class encyclopaedia.AchievementEncEntry(achievement: str, parent: Encyclopaedia | EncEntry | None = None, number: int | None = None, name: str = '', text: str | list[str] = '', subject: str = '', viewed: bool = False, viewed_persistent: bool | None = False, image: str | None = None, locked_name: str = '???', locked_text: str = '???', locked_image: str | None = None, locked_image_tint: tuple[float, float, float] = (0.0, 0.0, 0.0))[source]¶

EncEntry which uses Ren’Py’s achievement system to manage locked state.

Parameters:¶

achievement: str¶: The name of the achievement
parent: Encyclopaedia | EncEntry | None = None¶: The parent container for the EncEntry.
number: int | None = None¶: The entry’s number. If this is not set then it will be given a number automatically.
name: str = ''¶: Title, normally used for buttons and headings.
text: str | list[str] = ''¶: The text to be displayed when the entry is viewed.
subject: str = ''¶: The subject to associate the entry with. Used for sorting and filtering.
viewed: bool = False¶: Set the viewed status of the EncEntry. Default is False. Only use if the Encyclopaedia is save-game independent.
viewed_persistent: bool | None = False¶: Use persistent data for recording viewed status.
image: str | None = None¶: The image displayed with the Entry text. Default is None.
locked_name: str = '???'¶: Placeholder text for the name. Shown when the entry is locked.
locked_text: str = '???'¶: Placeholder text for the text. Shown when the entry is locked.
locked_image: str | None = None¶: Placeholder image for the image. Shown when the entry is locked.
locked_image_tint: tuple[float, float, float] = (0.0, 0.0, 0.0)¶: If no specific locked image is provided, a tinted version of the image will be used. The amount of tinting can be set with RGB values in a tuple.

property locked : bool¶: If the achievement is granted, consider the Entry unlocked.