Skip to content
ct

Class

PickupEvent

Generated GDScript class reference for ItemVault.PickupEvent.

Status
Draft
Version
v1.0
Updated
Development docs generated from GDScript source

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

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: reports `"2d"` or `"3d"` for the pickup source. 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