ToolAPI.ToolParams

Object containing additional parameters and functions used by Core Engine to work with the tool.

Hierarchy

• Scriptable
  • ToolParams
    • ToolParams

Index

Properties

• blockMaterials
• brokenId
• calcDestroyTime
• damage
• isNative
• isWeapon
• modifyEnchant
• onAttack
• onBroke
• onDestroy
• onMineBlock
• toolMaterial

Properties

optionalblockMaterials

blockMaterials?: {}

List of block material names that can be broken by this instrument. Defined by ToolAPI.registerTool,

---

Type declaration

• [key string]: boolean

optionalbrokenId

brokenId?: number = 0

Numeric ID of the item that replaces tool item when it's broken. By default the tool disappears.

optionalcalcDestroyTime

calcDestroyTime?: (tool: ItemInstance, coords: ItemUseCoordinates, block: Tile, timeData: { base: number; devider: number; modifier: number }, defaultTime: number, enchantData?: EnchantData) => number

Function used to recalculate block destroy time based on some custom logic.

---

Type declaration

• • (tool: ItemInstance, coords: ItemUseCoordinates, block: Tile, timeData: { base: number; devider: number; modifier: number }, defaultTime: number, enchantData?: EnchantData): number

  • Parameters

    • tool: ItemInstance

      Tool item.

    • coords: ItemUseCoordinates

      Coordinates where the block is being broken.

    • block: Tile

      Block that is being broken.

    • timeData: { base: number; devider: number; modifier: number }

      Some time properties that can be used to calculate destroy time for the tool and block.

    • base: number

      Base destroy time of the block.

    • devider: number

      Tool material devider.

    • modifier: number

      Divider applied due to efficiency enchantment.

    • defaultTime: number

      Default block destroy time, calculated as base / divider / modifier.

    • optionalenchantData: EnchantData

      Tool's enchant data.

    Returns number

optionaldamage

damage?: number = 0 // 4 in case of sword starting with 2.4.0b122o1

Base damage of the instrument, is added to the material damage to calculate the tool's final damage.

optionalisNative

internal

isNative?: boolean

If true, the tool is vanilla Minecraft tool. Generally used within Core Engine code and should not be used within mods until you really know what you're doing.

optionalisWeapon

isWeapon?: boolean

If true, breaking blocks with this tool makes it break 2x faster, otherwise attacking mobs breaks tool 2x faster.

optionalmodifyEnchant

modifyEnchant?: (enchantData: EnchantData, item: ItemInstance, coords?: ItemUseCoordinates, block?: Tile) => void

Function that is used to change enchant data object before all the calculations. Can be used to add some enchantment properties, such as silk touch, efficiency, unbreaking or fortune.

---

Type declaration

• • (enchantData: EnchantData, item: ItemInstance, coords?: ItemUseCoordinates, block?: Tile): void

  • Parameters

    • enchantData: EnchantData

      Tool's enchant data.

    • item: ItemInstance

      Tool item.

    • optionalcoords: ItemUseCoordinates

      Coordinates where the block is being broken. Passed only if the block is destroyed.

    • optionalblock: Tile

      Destroyed block data. Passed only if the block is destroyed.

    Returns void

optionalonAttack

onAttack?: (item: ItemInstance, victim: number, attacker: number) => boolean

Function that is called when players attacks some entity with the tool.

@returns

true if default damage should not be applied to the instrument, false otherwise.

---

Type declaration

• • (item: ItemInstance, victim: number, attacker: number): boolean

  • Parameters

    • item: ItemInstance

      Tool item.

    • victim: number

      Unique numeric ID of the entity that is attacked.

    • attacker: number

      Entity UID of the player that attacked victim.

    Returns boolean

optionalonBroke

onBroke?: (item: ItemInstance) => boolean

Function that is called when the instrument is broken.

@returns

true if default breaking behavior (replacing by brokenId item) should not be applied.

---

Type declaration

• • (item: ItemInstance): boolean

  • Parameters

    • item: ItemInstance

      Tool item.

    Returns boolean

optionalonDestroy

onDestroy?: (item: ItemInstance, coords: ItemUseCoordinates, block: Tile, player: number) => boolean

Function that is called when the block is destroyed.

@returns

true if default damage should not be applied to the instrument, false otherwise.

---

Type declaration

• • (item: ItemInstance, coords: ItemUseCoordinates, block: Tile, player: number): boolean

  • Parameters

    • item: ItemInstance

      Tool item.

    • coords: ItemUseCoordinates

      Coordinates where the block is destroyed.

    • block: Tile

      Block that is destroyed.

    • player: number

      Entity UID of the player that destroyed the block.

    Returns boolean

optionalonMineBlock

onMineBlock?: (coords: ItemUseCoordinates, carried: ItemInstance, fullTile: Tile, blockSource: BlockSource, player: number) => void

Function that is called when the block that has a destroy function is destroyed.

---

Type declaration

• • (coords: ItemUseCoordinates, carried: ItemInstance, fullTile: Tile, blockSource: BlockSource, player: number): void

  • Parameters

    • coords: ItemUseCoordinates

      Coordinates where the block is destroyed.

    • carried: ItemInstance

      An item in player's hand.

    • fullTile: Tile

      Block that was destroyed.

    • blockSource: BlockSource

      BlockSource object of the world where the block was destroyed.

    • player: number

      Entity UID of the player that destroyed the block.

    Returns void

optionaltoolMaterial

toolMaterial?: ToolMaterial

Properties of the tool material. Defined by ToolAPI.registerTool,