Events

All event listeners return a disconnect function when called, which can be executed to clean up and stop listening to the event.

Functions

onInventoryOpened()

Fires whenever the player's inventory interface is opened.

• Type

  function sling.onInventoryOpened(callback: () -> ()): () -> ()

onInventoryClosed()

Fires whenever the player's inventory interface is closed.

• Type

  function sling.onInventoryClosed(callback: () -> ()): () -> ()

onBackpackItemEquipped()

Fires when the player equips an item on character.

• Type

  function sling.onBackpackItemEquipped(callback: (item: BackpackItem) -> ()): () -> ()

onBackpackItemUnequipped()

Fires when the player unequips their currently active item.

• Type

  function sling.onBackpackItemUnequipped(callback: (item: BackpackItem) -> ()): () -> ()

onBackpackItemAdded()

Fires when an item is added to the player's backpack.

• Type

  function sling.onBackpackItemAdded(callback: (item: BackpackItem) -> ()): () -> ()

onBackpackItemRemoved()

Fires when an item is removed entirely from the player's backpack.

• Type

  function sling.onBackpackItemRemoved(callback: (item: BackpackItem) -> ()): () -> ()

onBackpackEmpty()

Fires when the backpack becomes entirely empty (contains no items).

• Type

  function sling.onBackpackEmpty(callback: () -> ()): () -> ()

onBackpackLoaded()

Fires whenever the backpack is fully loaded (typically when the player's character spawns and their items are fetched). If the backpack is already loaded at the time this function is called, the callback will be fired immediately. This makes it the ideal place to run setup code, such as applying saved hotbar layouts, without worrying about race conditions.

• Type

  function sling.onBackpackLoaded(callback: (items: { BackpackItem }) -> ()): () -> ()

onHotbarChanged()

Fires whenever the hotbar layout changes manually.

• Type

  function sling.onHotbarChanged(callback: (items: { BackpackItem }) -> ()): () -> ()