Item.ItemLegacyPrototype

Once upon a time, a new way of registering items, however, in current state, either does not work or is undesirable to use. *

That feature is obsolete

Since 3.1.1b127 warnings user of usage in developer mode.

Index

Properties

• getArmorFuncs
• getCategory
• getDefineParams
• getEnchant
• getMaxDamage
• getMaxUseDuration
• getName
• getProperties
• getTexture
• getToolMaterial
• getToolPrototype
• getToolTarget
• getUseAnimation
• init
• isEnchanted
• isStackedByData
• isToolRender
• onThrowableImpact
• onTick
• onUsed
• type

Properties

optionalgetArmorFuncs

getArmorFuncs?: (item: null) => IArmorJSCallback

Type declaration

• • (item: null): IArmorJSCallback

  • Parameters

    • item: null

    Returns IArmorJSCallback

optionalgetCategory

getCategory?: (item: null) => number

Type declaration

• • (item: null): number

  • Parameters

    • item: null

    Returns number

optionalgetDefineParams

getDefineParams?: (item: null) => ItemParams | FoodParams | ArmorParams

Type declaration

• • (item: null): ItemParams | FoodParams | ArmorParams

  • Parameters

    • item: null

    Returns ItemParams | FoodParams | ArmorParams

optionalgetEnchant

getEnchant?: (item: null) => number

Type declaration

• • (item: null): number

  • Parameters

    • item: null

    Returns number

optionalgetMaxDamage

getMaxDamage?: (item: null) => number

Type declaration

• • (item: null): number

  • Parameters

    • item: null

    Returns number

optionalgetMaxUseDuration

getMaxUseDuration?: (item: null) => number

Type declaration

• • (item: null): number

  • Parameters

    • item: null

    Returns number

getName

getName: (item: null) => string

Type declaration

• • (item: null): string

  • Parameters

    • item: null

    Returns string

optionalgetProperties

getProperties?: (item: null) => object

Cannot be used, because of properties should be passed as string, but properties here internally depends on object.

---

Type declaration

• • (item: null): object

  • Parameters

    • item: null

    Returns object

getTexture

getTexture: (item: null) => TextureData

Type declaration

• • (item: null): TextureData

  • Parameters

    • item: null

    Returns TextureData

optionalgetToolMaterial

getToolMaterial?: (item: null) => string | ToolMaterial

Type declaration

• • (item: null): string | ToolMaterial

  • Parameters

    • item: null

    Returns string | ToolMaterial

optionalgetToolPrototype

getToolPrototype?: (item: null) => ToolParams

Type declaration

• • (item: null): ToolParams

  • Parameters

    • item: null

    Returns ToolParams

optionalgetToolTarget

getToolTarget?: (item: null) => string[]

Type declaration

• • (item: null): string[]

  • Parameters

    • item: null

    Returns string[]

optionalgetUseAnimation

getUseAnimation?: (item: null) => number

Type declaration

• • (item: null): number

  • Parameters

    • item: null

    Returns number

optionalinit

init?: () => void

Type declaration

• • (): void

  • Returns void

optionalisEnchanted

isEnchanted?: (item: null) => boolean

Type declaration

• • (item: null): boolean

  • Parameters

    • item: null

    Returns boolean

optionalisStackedByData

isStackedByData?: (item: null) => boolean

Type declaration

• • (item: null): boolean

  • Parameters

    • item: null

    Returns boolean

optionalisToolRender

isToolRender?: (item: null) => boolean

Type declaration

• • (item: null): boolean

  • Parameters

    • item: null

    Returns boolean

optionalonThrowableImpact

onThrowableImpact?: (projectile: number, item: ItemInstance, target: ProjectileHitTarget) => void

Type declaration

• • (projectile: number, item: ItemInstance, target: ProjectileHitTarget): void

  • Parameters

    • projectile: number

    • item: ItemInstance

    • target: ProjectileHitTarget

    Returns void

optionalonTick

onTick?: (item: null) => void

Unused at all.

---

Type declaration

• • (item: null): void

  • Parameters

    • item: null

    Returns void

optionalonUsed

onUsed?: (coords: Vector, item: ItemInstance, block: Tile) => void

Type declaration

• • (coords: Vector, item: ItemInstance, block: Tile): void

  • Parameters

    • coords: Vector

    • item: ItemInstance

    • block: Tile

    Returns void

type

type: createItem | createFoodItem | createArmorItem | createThrowableItem