Skip to main content

Item Blacklist

Based on game build 722832 | Last updated: 2026-04-27

Overview

item_blacklist.lua defines five global tables used by the skin and account item system to control prefab visibility, decoration behavior, and unlock requirements. This is a configuration source file — it is not a component and does not attach to entities; it is required by other systems that need to validate skin display rules. The file is autogenerated by export_accountitems.lua and should not be manually edited. Tables use prefab names as string keys with boolean or string values indicating exclusion status or event lock requirements.

Usage example

local ItemBlacklist = require "item_blacklist"

-- Check if a prefab is excluded from display
if ItemBlacklist.ITEM_DISPLAY_BLACKLIST["abigail_flower_ancient"] then
-- Skip rendering this skin variant
end

-- Check if a prefab hides skin decorations
if ItemBlacklist.HIDE_SKIN_DECORATIONS["hermithouse_yule"] then
-- Do not apply decoration overlays
end

-- Check event lock requirement
local eventLock = ItemBlacklist.SKINS_EVENTLOCK["hermithouse_yule"]
if eventLock == "winters_feast" then
-- Only unlock during Winter's Feast event
end

-- Check if skin is unlockable
if ItemBlacklist.UNLOCKABLE_SKINS["w_radio_basic"] then
-- Allow player to unlock via gameplay
end

Dependencies & tags

External dependencies: None identified

Components used: None identified

Tags: None identified

Properties

PropertyTypeDefault ValueDescription
ITEM_DISPLAY_BLACKLISTtableMaps prefab names to true for items excluded from skin display selection. Contains 237 entries including Abigail flower variants, armor skins, boat items, and decorative structures.
HIDE_SKIN_DECORATIONStableMaps prefab names to true for items that should not show skin decoration overlays. Contains 23 entries focused on Hermit House and Winter's Feast decorative items.
SKINS_EVENTLOCKtableMaps prefab names to event string identifiers (e.g., "winters_feast") indicating which event must be active to unlock the skin. Contains 16 entries.
UNLOCKABLE_SKINStableMaps prefab names to true for skins that can be unlocked through gameplay rather than purchase. Contains 1 entry (w_radio_basic).
CRAFTING_RECIPE_UNLOCKED_SKINtableMaps prefab names to true for skins unlocked via crafting recipe discovery. Contains 1 entry (bulbin_rw_basic).
ITEM_DISPLAY_BLACKLIST[prefab]booleantrueIndividual entry: true means the prefab is blacklisted from display. Key is prefab name string.
HIDE_SKIN_DECORATIONS[prefab]booleantrueIndividual entry: true means decorations should be hidden for this prefab. Key is prefab name string.
SKINS_EVENTLOCK[prefab]string"winters_feast"Individual entry: event identifier string required to unlock. Key is prefab name string.
UNLOCKABLE_SKINS[prefab]booleantrueIndividual entry: true means the skin is unlockable. Key is prefab name string.
CRAFTING_RECIPE_UNLOCKED_SKIN[prefab]booleantrueIndividual entry: true means unlocked via crafting recipe. Key is prefab name string.

Main functions

None. This file defines static data tables only — no functions are exported.

Events & listeners

None.