Skip to main content

PickingUpItem

This is the type that is fed to the PRE_ITEM_PICKUP and POST_ITEM_PICKUP custom callbacks.

Interfaces

Type Aliases

PickingUpItem

Ƭ PickingUpItem: PickingUpItemNull | PickingUpItemCollectible | PickingUpItemTrinket

Defined in

packages/isaacscript-common/src/types/PickingUpItem.ts:11

Functions

newPickingUpItem

newPickingUpItem(): PickingUpItem

Returns

PickingUpItem

Defined in

packages/isaacscript-common/src/types/PickingUpItem.ts:46


resetPickingUpItem

resetPickingUpItem(pickingUpItem): void

Parameters

NameType
pickingUpItemPickingUpItem

Returns

void

Defined in

packages/isaacscript-common/src/types/PickingUpItem.ts:53


isPickingUpItemNull

isPickingUpItemNull(pickingUpItem): pickingUpItem is PickingUpItemTrinket

Helper function to narrow the type of PickingUpItem.

Parameters

NameType
pickingUpItemPickingUpItem

Returns

pickingUpItem is PickingUpItemTrinket

Defined in

packages/isaacscript-common/src/types/PickingUpItem.ts:65


isPickingUpItemCollectible

isPickingUpItemCollectible(pickingUpItem): pickingUpItem is PickingUpItemCollectible

Helper function to narrow the type of PickingUpItem.

Parameters

NameType
pickingUpItemPickingUpItem

Returns

pickingUpItem is PickingUpItemCollectible

Defined in

packages/isaacscript-common/src/types/PickingUpItem.ts:72


isPickingUpItemTrinket

isPickingUpItemTrinket(pickingUpItem): pickingUpItem is PickingUpItemTrinket

Helper function to narrow the type of PickingUpItem.

Parameters

NameType
pickingUpItemPickingUpItem

Returns

pickingUpItem is PickingUpItemTrinket

Defined in

packages/isaacscript-common/src/types/PickingUpItem.ts:79