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

ArmorSolarHelmet

Hierarchy

Implements

Index

Constructors

constructor

Properties

armorMaterial

armorMaterial: ArmorMaterial

Object containing armor properties specified by its material.

armorType

armorType: ArmorType

String type of armor.

defence

defence: number

Defence value for armor piece.

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

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

texture

texture: string

Armor texture.

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

onTick

  • onTick(item: ItemInstance, index: number, playerUid: number): void
  • This event is called when the damage is dealt to the player that has this armor put on.


    Parameters

    • item: ItemInstance

      armor item instance

    • index: number

      armor slot index (from 0 to 3).

    • playerUid: number

      player entity uid

    Returns void

    the item instance to change armor item, if nothing is returned, armor will not be changed.

preventDamaging

  • preventDamaging(): void
  • Prevents armor from being damaged.


    Returns void

setArmorTexture

  • setArmorTexture(name: string): void
  • Method that can be overrided to modify armor texture before item creation.


    Parameters

    • name: string

      armor texture path

    Returns void

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

setMaterial

  • Sets armor properties from armor material.


    Parameters

    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

staticregisterListeners

  • Registers all armor functions from given object.


    Parameters

    Returns void