Перейти к основному содержанию

abstractElectricTool

Object containing tool parameters and functions.

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • new ElectricTool(stringID: string, name: string, maxCharge: number, transferLimit: number, tier: number): ElectricTool

  • Parameters

    • stringID: string
    • name: string
    • maxCharge: number
    • transferLimit: number
    • tier: number

    Returns ElectricTool

Properties

canProvideEnergy

canProvideEnergy: boolean

If true, energy can be extracted from item

damage

damage: number

energy

energy: string

Type of energy stored in item

energyPerUse

energyPerUse: number

icon

icon: { meta: number; name: string }

Item texture data

Type declaration

  • meta: number
  • name: string

readonlyid

id: number

Item numeric id

inCreative

inCreative: boolean

item

item: NativeItem

Native class used to set item properties

maxCharge

maxCharge: number

Energy capacity of item

maxDamage

maxDamage: number

Maximum data value of the item

maxStack

maxStack: number

Maximum stack size of the item

name

name: string

Item name

readonlystringID

stringID: string

Item string id

tier

tier: number

Tier of item. Specifies where item can be charged or discharged.

toolMaterial

toolMaterial: ToolMaterial

transferLimit

transferLimit: number

Defines limit for transfering energy in item per 1 time

Methods

addDefaultToCreative

  • addDefaultToCreative(): void

  • Returns void

addRepairItem

  • addRepairItem(itemID: number): void

  • Adds material that can be used to repair the item in the anvil

    Parameters

    • itemID: number

      item id to be used as repair material

    Returns void

allowInOffHand

  • allowInOffHand(): void

  • Allows item to be put in off hand

    Returns void

calcDestroyTime

  • calcDestroyTime(item: ItemInstance, coords: ItemUseCoordinates, block: Tile, params: { base: number; devider: number; modifier: number }, destroyTime: number): number

  • Parameters

    • item: ItemInstance
    • coords: ItemUseCoordinates
    • block: Tile
    • params: { base: number; devider: number; modifier: number }
      • base: number
      • devider: number
      • modifier: number
    • destroyTime: number

    Returns number

getEnergyPerUse

  • getEnergyPerUse(item: ItemInstance): number

  • Parameters

    • item: ItemInstance

    Returns number

onAttack

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

  • Parameters

    • item: ItemInstance
    • victim: number
    • attacker: number

    Returns boolean

onBroke

  • onBroke(): boolean

  • Returns boolean

onDestroy

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

  • Parameters

    • item: ItemInstance
    • coords: ItemUseCoordinates
    • block: Tile
    • player: number

    Returns boolean

onNameOverride

  • onNameOverride(item: ItemInstance, name: string): string

  • Method to get displayed item name.

    Parameters

    • item: ItemInstance

      item stack information

    • name: string

      translated item name

    Returns string

    new name that will be displayed

setCategory

  • setCategory(category: number): void

  • Sets item creative category

    Parameters

    • category: number

      item category, should be integer from 1 to 4.

    Returns void

setEnchantType

  • setEnchantType(type: number, enchantability: number): void

  • Specifies how the item can be enchanted

    Parameters

    • type: number

      enchant type defining whan enchants can or cannot be applied to this item, one of the Native.EnchantType

    • enchantability: number

      quality of the enchants that are applied, the higher this value is, the better enchants you get with the same level

    Returns void

setGlint

  • setGlint(enabled: boolean): void

  • Sets item as glint (like enchanted tools or golden apple)

    Parameters

    • enabled: boolean

      if true, the item will be displayed as glint item

    Returns void

setHandEquipped

  • setHandEquipped(enabled: boolean): void

  • Specifies how the player should hold the item

    Parameters

    • enabled: boolean

      if true, player holds the item as a tool, not as a simple item

    Returns void

protectedsetIcon

  • setIcon(texture: string, index?: number): void

  • Method that can be overrided to modify item textures before item creation.

    Parameters

    • texture: string

      texture name

    • optionalindex: number

      texture index

    Returns void

setLiquidClip

  • setLiquidClip(): void

  • Allows item to click on liquid blocks

    Returns void

setMaxDamage

  • setMaxDamage(maxDamage: number): void

  • Sets item maximum data value

    Parameters

    • maxDamage: number

      maximum data value for the item

    Returns void

setMaxStack

  • setMaxStack(maxStack: number): void

  • Sets item maximum stack size

    Parameters

    • maxStack: number

      maximum stack size for the item

    Returns void

protectedsetName

  • setName(name: string): void

  • Method that can be overrided to modify item name before item creation.

    Parameters

    • name: string

      item name passed to the constructor

    Returns void

setProperties

  • setProperties(props: object): void

  • Sets properties for the item from JSON-like object. Uses vanilla mechanics.

    Parameters

    • props: object

      object containing properties

    Returns void

setRarity

  • setRarity(rarity: number): void

  • Sets item rarity.

    Parameters

    • rarity: number

      one of EnumRarity values

    Returns void

setToolParams

  • setToolParams(toolData: { blockMaterials?: string[]; damage?: number; efficiency: number; energyPerUse: number; level: number }): void

  • Parameters

    • toolData: { blockMaterials?: string[]; damage?: number; efficiency: number; energyPerUse: number; level: number }
      • optionalblockMaterials: string[]
      • optionaldamage: number
      • efficiency: number
      • energyPerUse: number
      • level: number

    Returns void

Page Options