builtin item - boyism80/fb GitHub Wiki

Built-in Functions Documentation (Item)

This document describes functions available to item type objects.

• model
• count
• durability
• rename

---

model

model()

• Description:
  Returns the item model (fb.model.item) object that this item references.
• Parameters:
  • None
• Return Value:
  • fb.model.item: Item model object
• Example:

  -- This is a real usage example from game scripts
  local item = me:item(0)
  if item then
      local model = item:model()
      me:message("Item: " .. model:name())
  end
  

---

count

count()

• Description:
  Returns the current stack count of the item.
• Parameters:
  • None
• Return Value:
  • number: Current item count
• Example:

  -- This is a real usage example from game scripts
  local item = me:item(0)
  if item and item:count() > 1 then
      me:message("You have " .. item:count() .. " items")
  end
  

---

durability

Provides two functionalities to get or set the item's durability.

durability()

• Description:
  Returns the current durability of the item. Returns nil if the item doesn't have durability.
• Parameters:
  • None
• Return Value:
  • number|nil: Current durability value, or nil if not applicable
• Example:

  -- This is a real usage example from game scripts
  local item = me:item(0)
  if item then
      local dur = item:durability()
      if dur then
          me:message("Durability: " .. dur)
      else
          me:message("This item has no durability")
      end
  end
  

durability(value:number)

• Description:
  Sets the item's durability to the specified value.
• Parameters:
  • value:number: Durability value to set
• Return Value:
  • None
• Example:

  -- This is a real usage example from game scripts
  local item = me:item(0)
  if item then
      item:durability(100)
      me:message("Item durability restored")
  end
  

---

rename

Provides functionality to get or set custom names for weapon items.

rename()

• Description:
  Returns the custom name of the weapon item. Returns nil if no custom name is set. Only works on weapon items.
• Parameters:
  • None
• Return Value:
  • string|nil: Custom name if set, nil otherwise
  • false: If the item is not a weapon
• Example:

  -- This is a real usage example from game scripts
  local weapon = me:item(0)
  if weapon then
      local custom_name = weapon:rename()
      if custom_name then
          me:message("Weapon name: " .. custom_name)
      end
  end
  

rename(name:string)

• Description:
  Sets a custom name for the weapon item. Only works on weapon items.
• Parameters:
  • name:string: Custom name to set
• Return Value:
  • None
  • false: If the item is not a weapon
• Example:

  -- This is a real usage example from game scripts
  local weapon = me:item(0)
  if weapon then
      weapon:rename("목검")
  end
  

rename(nil)

• Description:
  Removes the custom name from the weapon item, reverting to the original name. Only works on weapon items.
• Parameters:
  • nil: Pass nil to reset the custom name
• Return Value:
  • None
  • false: If the item is not a weapon
• Example:

  -- This is a real usage example from game scripts
  local weapon = me:item(0)
  if weapon then
      weapon:rename(nil)  -- Reset to original name
  end