Item Blacklist

Version History

Build Version	Change Date	Change Type	Description
676312	2025-06-25	modified	Added blacklist entries for waxed berrybush variants
676042	2025-06-21	stable	Previous version

Overview

The item_blacklist.lua module defines a blacklist system that controls which items should not be displayed in various UI contexts. This is primarily used to hide items that are variants, duplicates, or internal items that shouldn't be shown to players.

Usage Example

-- Check if an item should be hidden from display
if ITEM_DISPLAY_BLACKLIST[item_key] then
    -- Item is blacklisted, don't show it
    return
end

Constants

ITEM_DISPLAY_BLACKLIST

Status: modified in build 676312

Description: A table that maps item keys to true values for items that should be hidden from display in the UI. This blacklist is automatically generated and includes various skin variants, builder items, and other items that shouldn't be shown to players.

Type: table<string, boolean>

Usage Pattern: Items are blacklisted for several reasons:

• Skin Variants: Items like abigail_flower_ancient, abigail_flower_creepy that are variants of base items
• Builder Items: Items ending in _builder that are construction variants
• Internal Items: Items used internally but not meant for player display
• Duplicate Variants: Multiple versions of the same conceptual item

Example:

-- Check if an item is blacklisted
local function ShouldDisplayItem(item_key)
    return not ITEM_DISPLAY_BLACKLIST[item_key]
end

-- Filter a list of items
local function FilterDisplayableItems(item_list)
    local filtered = {}
    for _, item_key in ipairs(item_list) do
        if not ITEM_DISPLAY_BLACKLIST[item_key] then
            table.insert(filtered, item_key)
        end
    end
    return filtered
end

Common Blacklisted Categories:

• Abigail flower variants (ancient, creepy, formal, etc.)
• Bernie variants for different forms
• Building/construction item variants
• Skin variants for various items
• Internal boat and dock components
• Upgraded versions of base items

New Blacklist Additions (Build 676312): The following waxed berrybush variants have been added to the blacklist:

• berrybush_waxed_cawnival: Waxed carnival berrybush variant
• berrybush_waxed_mystical: Waxed mystical berrybush variant
• dug_berrybush_waxed_cawnival: Dug waxed carnival berrybush
• dug_berrybush_waxed_mystical: Dug waxed mystical berrybush

These items are blacklisted to prevent display duplication since they represent functional variants of existing berrybush items rather than distinct player-accessible items.

Related Modules

• Skins Utils: Uses this blacklist in ShouldDisplayItemInCollection()
• Prefabs: Item definitions that may be blacklisted
• Misc Items: Contains item data that this blacklist filters