PickingUpItem
This is the type that is fed to the PRE_ITEM_PICKUP and POST_ITEM_PICKUP custom callbacks.
Interfaces
Section titled “Interfaces”PickingUpItemNull
Section titled “PickingUpItemNull”Defined in: packages/isaacscript-common/src/types/PickingUpItem.ts:17
Part of PickingUpItem.
Properties
Section titled “Properties”itemType
Section titled “itemType”itemType:
NULL
Defined in: packages/isaacscript-common/src/types/PickingUpItem.ts:19
Needed so that we can distinguish between picking up a collectible and a trinket.
subType
Section titled “subType”subType:
0
Defined in: packages/isaacscript-common/src/types/PickingUpItem.ts:22
Equal to either the collectible type, the trinket type, or 0.
PickingUpItemCollectible
Section titled “PickingUpItemCollectible”Defined in: packages/isaacscript-common/src/types/PickingUpItem.ts:26
Part of PickingUpItem.
Properties
Section titled “Properties”itemType
Section titled “itemType”itemType:
PASSIVE|ACTIVE|FAMILIAR
Defined in: packages/isaacscript-common/src/types/PickingUpItem.ts:28
Needed so that we can distinguish between picking up a collectible and a trinket.
subType
Section titled “subType”subType:
CollectibleType
Defined in: packages/isaacscript-common/src/types/PickingUpItem.ts:31
Equal to either the collectible type, the trinket type, or 0.
PickingUpItemTrinket
Section titled “PickingUpItemTrinket”Defined in: packages/isaacscript-common/src/types/PickingUpItem.ts:35
Part of PickingUpItem.
Properties
Section titled “Properties”itemType
Section titled “itemType”itemType:
TRINKET
Defined in: packages/isaacscript-common/src/types/PickingUpItem.ts:37
Needed so that we can distinguish between picking up a collectible and a trinket.
subType
Section titled “subType”subType:
TrinketType
Defined in: packages/isaacscript-common/src/types/PickingUpItem.ts:40
Equal to either the collectible type, the trinket type, or 0.
Type Aliases
Section titled “Type Aliases”PickingUpItem
Section titled “PickingUpItem”PickingUpItem =
PickingUpItemNull|PickingUpItemCollectible|PickingUpItemTrinket
Defined in: packages/isaacscript-common/src/types/PickingUpItem.ts:13
Functions
Section titled “Functions”newPickingUpItem()
Section titled “newPickingUpItem()”newPickingUpItem():
PickingUpItem
Defined in: packages/isaacscript-common/src/types/PickingUpItem.ts:46
Returns
Section titled “Returns”resetPickingUpItem()
Section titled “resetPickingUpItem()”resetPickingUpItem(
pickingUpItem):void
Defined in: packages/isaacscript-common/src/types/PickingUpItem.ts:54
Helper function to reset a PickupUpItem object to all 0 values.
Parameters
Section titled “Parameters”pickingUpItem
Section titled “pickingUpItem”Returns
Section titled “Returns”void
isPickingUpItemNull()
Section titled “isPickingUpItemNull()”isPickingUpItemNull(
pickingUpItem):pickingUpItem is PickingUpItemTrinket
Defined in: packages/isaacscript-common/src/types/PickingUpItem.ts:66
Helper function to narrow the type of PickingUpItem to ItemType.NULL (0).
Parameters
Section titled “Parameters”pickingUpItem
Section titled “pickingUpItem”Returns
Section titled “Returns”pickingUpItem is PickingUpItemTrinket
isPickingUpItemCollectible()
Section titled “isPickingUpItemCollectible()”isPickingUpItemCollectible(
pickingUpItem):pickingUpItem is PickingUpItemCollectible
Defined in: packages/isaacscript-common/src/types/PickingUpItem.ts:79
Helper function to narrow the type of PickingUpItem to one of the following:
ItemType.PASSIVE(1)ItemType.ACTIVE(3)ItemType.FAMILIAR(4)
Parameters
Section titled “Parameters”pickingUpItem
Section titled “pickingUpItem”Returns
Section titled “Returns”pickingUpItem is PickingUpItemCollectible
isPickingUpItemTrinket()
Section titled “isPickingUpItemTrinket()”isPickingUpItemTrinket(
pickingUpItem):pickingUpItem is PickingUpItemTrinket
Defined in: packages/isaacscript-common/src/types/PickingUpItem.ts:86
Helper function to narrow the type of PickingUpItem to ItemType.TRINKET (2).
Parameters
Section titled “Parameters”pickingUpItem
Section titled “pickingUpItem”Returns
Section titled “Returns”pickingUpItem is PickingUpItemTrinket