Scrapbookscreen

Based on game build 714014 | Last updated: 2026-03-09

Overview

The ScrapbookScreen class implements the scrapbook interface, a player-facing UI that visually displays unlocked game knowledge (e.g., creatures, recipes, items). It manages data filtering by category and search text, grid layout with configurable columns, dynamic entry details panel with stats, photos, dependencies, crafting recipes, and character quotes, and handles keyboard/controller input, focus routing, and visibility flash indicators for unviewed items. It persists user preferences (e.g., column count) and viewed status via TheScrapbookPartitions and Profile, and integrates with the global dataset and localization system.

Usage example

-- Open the scrapbook screen programmatically
TheMod:LoadPostInit(function()
    local function open_scrapbook()
        TheMod:PushEvent("open_scrapbook")
    end

    local function on_event()
        local screen = ScrapbookScreen()
        TheFrontEnd:PushScreen(screen)
    end

    TheMod:ListenForEvent("open_scrapbook", on_event, TheMod)
end)

Dependencies & tags

Components used: TheScrapbookPartitions, Profile, ThePlayer, TheFrontEnd, TheInput, TheNet, TheInventory, GetScrapbookIconAtlas, GetInventoryItemAtlas, STRINGS, RecipesFilter (via recipes_filter.lua), scrapbookdata (via screens/redux/scrapbookdata.lua) Tags: None

Properties

Property	Type	Default Value	Description
`self.inst`	`Entity`	`nil`	Owning entity instance (typically `ThePlayer`)
`self.root`	`Widget`	`nil`	Main screen container root
`self.letterbox`	`Widget`	`nil`	Letterbox container for screen edges
`self.bg`	`Widget`	`nil`	Background layer
`self.title`	`Widget`	`nil`	Screen title widget
`self.dialog`	`Widget`	`nil`	Dialog container (left side)
`self.detailsroot`	`Widget`	`nil`	Container for entry details panel
`self.gridroot`	`Widget`	`nil`	Container for item grid panel
`self.item_grid`	`Widget`	`nil`	Scrolling grid of scrapbook entries
`self.details`	`Widget`	`nil`	Top-level details container widget
`self.menubuttons`	`Array<Widget>`	`{}`	Sidebar category buttons
`self.last_filter`	`String?`	`nil`	Previously selected category filter
`self.menubuttons_selected`	`String?`	`nil`	Currently selected category
`self.current_dataset`	`Array<Table>`	`{}`	Dataset entries for current category
`self.current_view_data`	`Array<Table>`	`{}`	View data after search/filter
`self.columns_setting`	`Number`	`3`	Column count for grid (1, 2, 3, or 7)
`self.searchbox`	`Widget`	`nil`	Search input widget
`self.topbuttons`	`Widget?`	`nil`	Top bar container (search, column toggle)
`self.clearflash`	`Widget?`	`nil`	Clear-flash button (non-controller mode only)
`self.cancel_button`	`Widget`	`nil`	Cancel/back button
`self.closing`	`Boolean`	`false`	Whether screen is being closed
`self.flashestoclear`	`Boolean`	`false`	Whether any flashes exist to clear
`self.focus_forward`	`Widget?`	`self.item_grid`	Widget receiving focus on open
`self.depsbuttons`	`Array<Widget>?`	`nil`	Dependency buttons in details panel
`self.character_panels_total`	`Number`	`0`	Total character quote panels
`self.current_panel`	`Number?`	`nil`	Index of currently shown character quote panel
`self.character_pannel_first`	`Widget?`	`nil`	First character quote panel widget

Main functions

`GetPeriodString(period)`

Description: Converts a period in ticks into a localized, human-readable time string using appropriate units (seconds, minutes, days). It maps ticks to days (≈60 ticks/second, 8 seconds/day) and formats using STRINGS.SCRAPBOOK.DATA_* entries.
Parameters:
period: Number — time elapsed in ticks (e.g., 480 ≈ 8 seconds).
Returns: String — formatted time string (e.g., "2 minutes" or "1 day").