Class ItemExtraData

Class representing item extra data. Used to store additional information about item other then just item ID and data.

Constructors

constructor

Methods

addEnchant applyTo asJson copy getAllCustomData getAllEnchantNames getBoolean getCompoundTag getCustomName getEnchantCount getEnchantLevel getEnchantName getEnchants getFloat getInt getLong getRawEnchants getSerializable getString getValue isEmpty isEnchanted isFinalizableInstance putBoolean putFloat putInt putLong putObject putSerializable putString removeAllEnchants removeCustomData removeEnchant setAllCustomData setCompoundTag setCustomName cloneExtra fromJson getExtraOrNull getValueOrNullPtr unwrapObject unwrapValue

Constructors

constructor

Methods

addEnchant

  • addEnchant(type, level): void

  • Adds a new enchantment to the item.

    Parameters

    • type: number

      enchantment ID, one of the EEnchantment constants

    • level: number

      enchantment level, generally between 1 and 5

    Returns void

applyTo

asJson

copy

getAllCustomData

getAllEnchantNames

  • getAllEnchantNames(): string

  • Returns string

    All enchantments names separated by line breaks.

getBoolean

  • getBoolean(name, fallback?): boolean

  • Parameters

    • name: string

      parameter name

    • Optionalfallback: boolean

      default value to be returned if item extra data doesn't contain a parameter with specified name

    Returns boolean

    Custom boolean parameter value if extra data of the item contains one, fallback value otherwise. If fallback was not specified, null is returned.

getCompoundTag

getCustomName

getEnchantCount

  • getEnchantCount(): number

  • Returns number

    Amount of enchantments applied to the item.

getEnchantLevel

  • getEnchantLevel(type): number

  • Parameters

    • type: number

      enchantment ID, one of the EEnchantment constants

    Returns number

    Level of the specified enchantment.

getEnchantName

  • getEnchantName(id, level): string

  • Parameters

    • id: number

      enchantment ID, one of the EEnchantment constants

    • level: number

      enchantment level, generally between 1 and 5

    Returns string

    Enchantment name by it's ID and level.

    Since

    2.2.1b94 (not worked before)

getEnchants

  • getEnchants(): {
        [id: number]: number;
    }

  • Returns {
        [id: number]: number;
    }

    • [id: number]: number

getFloat

  • getFloat(name, fallback?): number

  • Parameters

    • name: string

      parameter name

    • Optionalfallback: number

      default value to be returned if item extra data doesn't contain a parameter with specified name

    Returns number

    Custom float parameter value if extra data of the item contains one, fallback value otherwise. If fallback was not specified, null is returned.

getInt

  • getInt(name, fallback?): number

  • Parameters

    • name: string

      parameter name

    • Optionalfallback: number

      default value to be returned if item extra data doesn't contain a parameter with specified name

    Returns number

    Custom integer parameter value if extra data of the item contains one, fallback value otherwise. If fallback was not specified, null is returned.

getLong

  • getLong(name, fallback?): number

  • Parameters

    • name: string

      parameter name

    • Optionalfallback: number

      default value to be returned if item extra data doesn't contain a parameter with specified name

    Returns number

    Custom long integer parameter value if extra data of the item contains one, fallback value otherwise. If fallback was not specified, null is returned.

getRawEnchants

getSerializable

getString

  • getString(name, fallback?): string

  • Parameters

    • name: string

      parameter name

    • Optionalfallback: string

      default value to be returned if item extra data doesn't contain a parameter with specified name

    Returns string

    Custom string parameter value if extra data of the item contains one, fallback value otherwise. If fallback was not specified, null is returned.

getValue

isEmpty

  • isEmpty(): boolean

  • Returns boolean

    true, if item extra exists and is not empty.

isEnchanted

  • isEnchanted(): boolean

  • Returns boolean

    true if the item is enchanted, false otherwise.

isFinalizableInstance

putBoolean

  • putBoolean(name, bool): ItemExtraData

  • Puts some custom boolean parameter to the extra data of the item.

    Parameters

    • name: string

      parameter name

    • bool: boolean

      parameter value

    Returns ItemExtraData

    Reference to itself to be used in sequential calls.

putFloat

  • putFloat(name, float): ItemExtraData

  • Puts some custom floating point number parameter to the extra data of the item.

    Parameters

    • name: string

      parameter name

    • float: number

      parameter value

    Returns ItemExtraData

    Reference to itself to be used in sequential calls.

putInt

  • putInt(name, int): ItemExtraData

  • Puts some custom integer parameter to the extra data of the item.

    Parameters

    • name: string

      parameter name

    • int: number

      parameter value

    Returns ItemExtraData

    Reference to itself to be used in sequential calls.

putLong

  • putLong(name, long): ItemExtraData

  • Puts some custom long integer parameter to the extra data of the item.

    Parameters

    • name: string

      parameter name

    • long: number

      parameter value

    Returns ItemExtraData

    Reference to itself to be used in sequential calls.

putObject

putSerializable

putString

  • putString(name, value): ItemExtraData

  • Puts some custom string parameter to the extra data of the item.

    Parameters

    • name: string

      parameter name

    • value: string

      parameter value

    Returns ItemExtraData

    Reference to itself to be used in sequential calls.

removeAllEnchants

  • removeAllEnchants(): void

  • Removes all the enchantments of the item.

    Returns void

removeCustomData

  • removeCustomData(): void

  • Removes all custom parameters from item extra data.

    Returns void

removeEnchant

  • removeEnchant(type): void

  • Removes enchantments by it's ID.

    Parameters

    • type: number

      enchantment ID, one of the EEnchantment constants

    Returns void

setAllCustomData

setCompoundTag

  • setCompoundTag(ent, tag): void

  • Sets compound tag for the specified item.

    Parameters

    Returns void

    Since

    2.0.5b44

setCustomName

  • setCustomName(name): void

  • Sets item's custom name.

    Parameters

    • name: string

    Returns void

StaticcloneExtra

StaticfromJson

StaticgetExtraOrNull

StaticgetValueOrNullPtr

StaticunwrapObject

StaticunwrapValue

Settings

Member Visibility

On This Page

Constructors
Methods

Copyright © 2024 Nernar. Copyright © 2020 #mineprogramming. Built with ❤ and TypeDoc.