Skip to content

event onPlayerUseItem (server-side)

Available since version: 0.3.0

Note

This event can be cancelled.

This event is triggered when the player/npc attempts to use an item.

Parameters

void onPlayerUseItem(number player_id, ItemDefinition|nil item, number quantity, string scheme)
  • number player_id: Player/npc using the item.
  • ItemDefinition|nil item: ItemDefinition definition, or nil for an unknown item.
  • number quantity: Amount consumed; zero for a reusable item.
  • string scheme: ItemDefinition use scheme.