Skip to content

Class "ItemConfig"⚓︎

Info

ItemConfig does have a special Enum. you can find it here ItemConfigEnums

You can get this class by using the following function:

Example Code

Isaac.GetItemConfig()

Content Overview

Return valueFunction
const ItemConfig CardGetCard ( Card ID )⚓︎
const CardListGetCards ( )⚓︎
const ItemConfig ItemGetCollectible ( CollectibleType ID )⚓︎
const userdataGetCollectibles ( )⚓︎
const ItemConfig ItemGetNullItem ( NullItemID ID )⚓︎
const ItemListGetNullItems ( )⚓︎
const ItemConfig PillEffectGetPillEffect ( PillEffect ID )⚓︎
const PillListGetPillEffects ( )⚓︎
const ItemConfig ItemGetTrinket ( TrinketType ID )⚓︎
const ItemListGetTrinkets ( )⚓︎
static booleanIsValidCollectible ( CollectibleType ID )⚓︎
static booleanShouldAddCostumeOnPickup ( ItemConfig Item Config )⚓︎

Functions⚓︎

GetCard ()⚓︎

const ItemConfig Card GetCard ( Card ID )⚓︎

Returns nil if no itemconfig to the given ID can be found.

GetCards ()⚓︎

const CardList GetCards ( )⚓︎

Bugs

Calling Get() in this list does not return usable userdata, rendering it useless for that purpose.

GetCollectible ()⚓︎

const ItemConfig Item GetCollectible ( CollectibleType ID )⚓︎

Returns the Itemobject of a given CollectibleID. Returns nil of nothing was found.

Example Code

This function gets the item config of sad onion.

1
    Isaac.GetItemConfig():GetCollectible(1)

GetCollectibles ()⚓︎

const userdata GetCollectibles ( )⚓︎

Returns the List of all Collectibles.

Bug

This function is broken and returns userdata.

Example Code

This Code gets the highest possible collectible id including modded items.

1
2
3
function GetMaxCollectibleID()
    return Isaac.GetItemConfig():GetCollectibles().Size -1
end
Bugs

Calling Get() in this list does not return usable userdata, rendering it useless for that purpose.

GetNullItem ()⚓︎

const ItemConfig Item GetNullItem ( NullItemID ID )⚓︎

Returns nil if no itemconfig to the given ID can be found.

GetNullItems ()⚓︎

const ItemList GetNullItems ( )⚓︎

Bugs

Calling Get() in this list does not return usable userdata, rendering it useless for that purpose.

GetPillEffect ()⚓︎

const ItemConfig PillEffect GetPillEffect ( PillEffect ID )⚓︎

Returns nil if no itemconfig to the given ID can be found.

GetPillEffects ()⚓︎

const PillList GetPillEffects ( )⚓︎

Bugs

Calling Get() in this list does not return usable userdata, rendering it useless for that purpose.

GetTrinket ()⚓︎

const ItemConfig Item GetTrinket ( TrinketType ID )⚓︎

Returns nil if no itemconfig to the given ID can be found.

GetTrinkets ()⚓︎

const ItemList GetTrinkets ( )⚓︎

Bugs

Calling Get() in this list does not return usable userdata, rendering it useless for that purpose.

IsValidCollectible ()⚓︎

static boolean IsValidCollectible ( CollectibleType ID )⚓︎

Function to check if a given item id is a valid collectible id (aka. this item exists). Returns True when it exists and False when it doesn't.

Since this function is a static function, the usage is a bit different. Take a look at the example code for the correct usage

Example Code

This Code checks, if the item "Sad Onion" (ID: 1) exists. 

1
ItemConfig.Config.IsValidCollectible(1)

ShouldAddCostumeOnPickup ()⚓︎

static boolean ShouldAddCostumeOnPickup ( ItemConfig Item Config )⚓︎

Returns weather a given item config object should add a costume when picking up the associated item.

Since this function is a static function, the usage is a bit different. Take a look at the example code for the correct usage

Example Code

This Code checks, if the item "Sad Onion" (ID: 1) should add a costume on Pickup. 

1
2
local sadOnionItemConfig = Isaac.GetItemConfig():GetCollectible(1)
ItemConfig.Config.ShouldAddCostumeOnPickup(sadOnionItemConfig) -- returns true

Last update: March 20, 2025