search
BuiltByBitPatreonDiscord

Sword API

hashtag
Overview

The sword system manages player weapon progression through various skins, tiers, and upgrades. It handles the creation and validation of sword items with custom properties, damage values, and visual appearances.

hashtag
Sword Item Management

hashtag
Item Retrieval

ItemStack getSwordItemFromPlayer(Player player)

  • Description: Gets the current sword item for a player based on their progression

  • Parameters: player - Target player

  • Returns: ItemStack representing the player's current sword

  • Usage: Equipment updates, inventory management, display purposes

hashtag
Item Validation

boolean isItemSword(ItemStack item)

  • Description: Checks if an ItemStack is a valid EdDungeons sword

  • Parameters: item - ItemStack to validate

  • Returns: True if the item is an EdDungeons sword, false otherwise

  • Usage: Event handling, inventory filtering, item validation

hashtag
Get Sword Damage From Player

BigDecimal getPlayerSwordDamage(ItemStack item)

  • Description: Gets the damage from the player's sword in their inventory.

  • Parameters: item - The sword itemstack.

  • Returns: The damage. Will return BigDecimal.ZERO if the player has no sword.

PreviousLeveling APINextZones API

Last updated