Skip to content

Class "EntityPickup"⚓︎

Class Diagram⚓︎

    classDiagram
    class Entity:::diagramCurrentPage
    class EntityBomb
    class EntityEffect
    class EntityFamiliar
    class EntityKnife
    class EntityLaser
    class EntityNPC
    class EntityPickup
    class EntityPlayer
    class EntityProjectile
    class EntitySlot
    class EntityTear
    Entity <|-- EntityBomb
    Entity <|-- EntityEffect
    Entity <|-- EntityFamiliar
    Entity <|-- EntityKnife
    Entity <|-- EntityLaser
    Entity <|-- EntityNPC
    Entity <|-- EntityPickup
    Entity <|-- EntityPlayer
    Entity <|-- EntityProjectile
    Entity <|-- EntitySlot
    Entity <|-- EntityTear
    link Entity "https://wofsauge.github.io/IsaacDocs/rep/Entity.html" "Go to page for 'Entity' class"
    link EntityBomb "https://wofsauge.github.io/IsaacDocs/rep/EntityBomb.html" "Go to page for 'EntityBomb' class"
    link EntityEffect "https://wofsauge.github.io/IsaacDocs/rep/EntityEffect.html" "Go to page for 'EntityEffect' class"
    link EntityFamiliar "https://wofsauge.github.io/IsaacDocs/rep/EntityFamiliar.html" "Go to page for 'EntityFamiliar' class"
    link EntityKnife "https://wofsauge.github.io/IsaacDocs/rep/EntityKnife.html" "Go to page for 'EntityKnife' class"
    link EntityLaser "EntityLaser.html" "Go to page for 'EntityLaser' class"
    link EntityNPC "EntityNPC.html" "Go to page for 'EntityNPC' class"
    link EntityPickup "EntityPickup.html" "Go to page for 'EntityPickup' class"
    link EntityPlayer "EntityPlayer.html" "Go to page for 'EntityPlayer' class"
    link EntityProjectile "https://wofsauge.github.io/IsaacDocs/rep/EntityProjectile.html" "Go to page for 'EntityProjectile' class"
    link EntitySlot "EntitySlot.html" "Go to page for 'EntitySlot' class"
    link EntityTear "https://wofsauge.github.io/IsaacDocs/rep/EntityTear.html" "Go to page for 'EntityTear' class"

Functions⚓︎

AddCollectibleCycle ()⚓︎

boolean AddCollectibleCycle ( int id )⚓︎

CanReroll ()⚓︎

boolean CanReroll ( )⚓︎

GetAlternatePedestal ()⚓︎

int GetAlternatePedestal ( )⚓︎

GetCollectibleCycle ()⚓︎

CollectibleType[] GetCollectibleCycle ( )⚓︎

Returns a table of all CollectibleTypes being used inside its collectible cycle (i.e. Glitched Crown).

GetDropDelay ()⚓︎

int GetDropDelay ( )⚓︎

GetFlipCollectible ()⚓︎

CollectibleType GetFlipCollectible ( )⚓︎

Returns CollectibleType if Flip save state exists, nil otherwise.

GetLootList ()⚓︎

LootList GetLootList ( boolean shouldAdvance = false )⚓︎

Returns a read-only version of the pickup's LootList. Loot inside pickups can be seen through use of the Guppy's Eye collectible.

shouldAdvance determines if the loot RNG should advance or not.

GetMegaChestLeftCollectible ()⚓︎

EntityPickup GetMegaChestLeftCollectible ( )⚓︎

If called on an EntityPickup for the right-side of an open Mega Chest, returns the left-side collectible. Otherwise returns nil.

GetMegaChestOtherCollectible ()⚓︎

EntityPickup, boolean GetMegaChestRightCollectible ( )⚓︎

If called on an EntityPickup belonging to an open Mega Chest, returns the other collectible and a boolean indicating if this collectible is on the right-side. Otherwise, returns nil.

GetMegaChestRightCollectible ()⚓︎

EntityPickup GetMegaChestRightCollectible ( )⚓︎

If called on an EntityPickup for the left-side of an open Mega Chest, returns the right-side collectible. Otherwise returns nil.

GetPickupGhost ()⚓︎

EntityEffect GetPickupGhost ( )⚓︎

Returns the EffectVariant.PICKUP_GHOST EntityEffect visible through Guppy's Eye. If not visible, returns nil.

GetPriceSprite ()⚓︎

Sprite GetPriceSprite ( )⚓︎

GetRandomPickupVelocity ()⚓︎

Vector GetRandomPickupVelocity ( Vector Position, RNG RNG = nil, int VelocityType = 0 )⚓︎

VelocityType 0 will shoot pickups in a random direction around the wanted position. VelocityType 1 will shoot pickups in a cone pointing down, mostly used for Beggar payouts. VelocityType also seems to affect pickups in Challenge Rooms, causing them to have a weaker velocity.

Warning

This is a static function and must be called via EntityPickup.GetRandomPickupVelocity(Position, RNG, VelocityType).

GetVarData ()⚓︎

int GetVarData ( )⚓︎

HasFlipData ()⚓︎

boolean HasFlipData ( )⚓︎

Returns true if pickup is collectible and has Flip save state.

InitFlipState ()⚓︎

void InitFlipState ( CollectibleType = CollectibleType.COLLECTIBLE_NULL, boolean SetupCollectibleGraphics = true )⚓︎

Initiates the flip state for the pickup with the provided CollectibleType.

IsBlind ()⚓︎

boolean IsBlind ( )⚓︎

Returns true if the pickup is a collectible pedestal and is hidden. Always returns false for non-collectible EntityPickups.

Warning

This value does not account for curse of the blind, it only reflects the blind state of pickups that are normally blind without curses involved. Ex: alt path's extra item.

MakeShopItem ()⚓︎

void MakeShopItem ( int ShopItemID )⚓︎

ReloadGraphics ()⚓︎

void ReloadGraphics ( boolean IgnoreBlind )⚓︎

RemoveCollectibleCycle ()⚓︎

void RemoveCollectibleCycle ( )⚓︎

SetAlternatePedestal ()⚓︎

void SetAlternatePedestal ( int PedestalType )⚓︎

Sets the graphics of the item pedestal. Does nothing for non-collectible EntityPickups.

SetDropDelay ()⚓︎

void SetDropDelay ( int Delay )⚓︎

SetForceBlind ()⚓︎

void SetForceBlind ( boolean SetBlind )⚓︎

Hides pedestal items similar to Curse of the Blind. Does nothing for non-collectible EntityPickups.

SetNewOptionsPickupIndex ()⚓︎

int SetNewOptionsPickupIndex ( )⚓︎

Returns the new pickup index.

SetupCollectibleGraphics ()⚓︎

static void SetupCollectibleGraphics ( Sprite Sprite, integer Layer, CollectibleType Collectible, boolean Blind = false, integer Seed = Random(), boolean LoadGraphics = false )⚓︎

Static method. Used to replace layer's spritesheet of the sprite object with collectible sprite. Seed is used for April Fools challenge to choose random collectible.

SetVarData ()⚓︎

void SetVarData ( int VarData )⚓︎

TriggerTheresOptionsPickup ()⚓︎

void TriggerTheresOptionsPickup ( )⚓︎

Removes pickups with the same option group (OptionsPickupIndex) as the target pickup.

TryFlip ()⚓︎

boolean TryFlip ( )⚓︎

Will try to flip the collectible, such as when using the Flip item on a collectible pedestal with a second, holographic collectible present behind the first one. Returns true if successful, false otherwise or if used on non-collectible EntityPickups.

TryInitOptionCycle ()⚓︎

boolean TryInitOptionCycle ( int NumCycle )⚓︎

Causes the collectible pedestal to start cycling through the specified amount of collectibles, including its own collectible type.

TryRemoveCollectible ()⚓︎

boolean TryRemoveCollectible ( )⚓︎

Attempts to remove the collectible from an item pedestal.

Returns true if a collectible was successfully removed from the pedestal. Returns false if the pedestal was already empty, or if called on a non-collectible EntityPickup.

UpdatePickupGhosts ()⚓︎

void UpdatePickupGhosts ( )⚓︎

Updates the EffectVariant.PICKUP_GHOST EntityEffect in accordance to the pickup's current LootList