Comment on page

PlayerPickupItem

Fires when a player collects an item from the ground.
Example usage:
Events.PlayerPickupItem(function(event)
if (event.player:getEntity() == nil) then
return
end
if (event.itemType == ItemType.GLITCH_TRUMPET) then
EntityService.spawnKitEntity(KitType.MELODY, event.player:getEntity():getPosition())
AnnouncementService.sendAnnouncement("Let's jam!")
end
end)

Parameters

player: Player

The player that is picking up the item.

itemType: ItemType

The type of item that is being picked up by the player.

amount: number

The amount of the item that is being picked up by the player.

cancelled: bool [modifiable]

If set to true, the item pickup event will be cancelled.