Chris' Tutorials
Docs/Item Vault

Class

PickupEvent

Generated GDScript class reference for ItemVault.PickupEvent.

StatusDraft
Versionv1.0
UpdatedDevelopment docs generated from GDScript source

This is unreleased documentation in active development. APIs, class names, and behavior may change before the final release.

Draft — Unreleased:This page is in active development. APIs, class names, and behavior may change before the release is finalized. Use it as a preview of what's coming — not as a stable integration target.

Source: addons/item_vault/pickups/pickup_event.gd

Syntax

class PickupEvent extends RefCounted

Members

NameKindSummary
pickupPropertyOccurrence data for an item being successfully picked up from the game scene. The object being picked up.
collectorPropertyThe object picking up the node.
stackPropertyThe resolved item stack picked up from the pickup scene.
dimensionPropertyDiagnostics only: `"2d"` or `"3d"`. Behavior must not branch on this.
overflowPropertyOverflow remaining after the inventory target attempted to accept the stack. Set by InventoryPickupBridge during signal handling. Null means fully accepted. Pickup2D/Pickup3D read this in take() to decide whether to free or remain.
fully_acceptedMethod
fully_rejectedMethod

Source

addons/item_vault/pickups/pickup_event.gd

Plugin docs root:gdscript/plugins/item_vault_dev/addons/item_vault/guides