ItemDatabase

Singleton ScriptableObject that serves as the central registry of all IItemFactory assets. Provides static lookup of item factories by ID for spawning items at runtime.

Definition

Namespace: Paragon.Townskeep.ItemSystem Assembly: Townskeep.dll

[SingletonSettings(AssetPath = "Item/Item Database")]
public class ItemDatabase : ScriptableFactoryDatabase<ItemDatabase, IItemFactory<Item, ItemData>>

Inheritance: SingletonScriptableObject<ItemDatabase> → ScriptableFactoryDatabase<ItemDatabase, IItemFactory<Item, ItemData>> → ItemDatabase

Remarks

ItemDatabase is a thin specialization of the generic ScriptableFactoryDatabase from the Scriptable Factory system. It automatically discovers all IItemFactory<Item, ItemData> assets via the ScriptableFactoryRegistry on OnEnable() and indexes them in a dictionary keyed by each factory's hash code (which equals ItemData.ItemID).

The asset is located at Resources/Item/Item Database (configured via [SingletonSettings]).

Factory hash codes are set to ItemData.ItemID by the ItemFactory override of GetHashCode(). This means ItemDatabase.GetFactory(itemId) looks up by the item's type ID.

Quick Lookup

Goal	How
Get a factory by ID	ItemDatabase.GetFactory(itemId)
Spawn an item by ID	ItemDatabase.GetFactory(itemId).NetworkSpawn(variantId)
Asset location	Resources/Item/Item Database

Methods (inherited)

GetFactory (static)

Returns the item factory registered with the given ID.

public static IItemFactory<Item, ItemData> GetFactory(int index)

Parameter	Type	Description
index	int	The item type ID (matches ItemData.ItemID / factory hash code)

Returns: The IItemFactory<Item, ItemData> instance for the given ID.

Throws KeyNotFoundException if no factory is registered with the given ID. Ensure the factory ScriptableObject exists and has been discovered by the registry.

OnEnable (inherited, virtual)

Called by Unity when the ScriptableObject is loaded. Populates the internal factory dictionary from ScriptableFactoryRegistry.

protected virtual void OnEnable()

Common Pitfalls

Missing factory asset GetFactory() throws KeyNotFoundException if the ID doesn't match any registered factory. This typically means the factory ScriptableObject was deleted or its ItemData.ItemID was changed without updating references.

Hash code = ItemID The dictionary key is the factory's GetHashCode(), which ItemFactory overrides to return ItemData.ItemID. If a custom factory subclass overrides GetHashCode() differently, lookups will break.

Implicit int conversion from ItemID ItemDatabase.GetFactory(itemId) works because ItemID has an implicit conversion to int that returns TypeID. The VariantID is not used for database lookup — it's used after retrieval when calling NetworkSpawn(variantId).

Examples

Spawning an Item by ID

ItemID swordId = new ItemID(1, 0);
IItemFactory<Item, ItemData> factory = ItemDatabase.GetFactory(swordId);
Item sword = factory.NetworkSpawn(swordId.VariantID);
sword.transform.position = spawnPoint.position;

Using ItemSpawner (higher-level API)

// ItemSpawner wraps the database lookup pattern:
Item item = ItemSpawner.Spawn(new ItemID(1, 2));

See Also

• IItemFactory — interface for registered factories

• ItemFactory — abstract factory implementation

• ItemID — composite identifier used for lookups

• ItemData — data record defining item properties