ItemModel

Class representing item model in player's hand and/or inventory. To get an instance of this class from your code, use ItemModel.getFor static function.

@remarks

The coordinates of the full block in player's hand or inventory is (0, 0, 0), (1, 1, 1), so it is generally recommended to use the models that fit that bound at least for the inventory.

@since

2.0.2b20

Index

Properties

• data
• id

Methods

• addToMesh
• getCacheKey
• getIconBitmap
• getIconBitmapNoReload
• getItemRenderMesh
• getMeshTextureName
• getModelForItemInstance
• getShaderUniforms
• getSpriteMesh
• getUiGlintMaterialName
• getUiMaterialName
• getUiTextureName
• getWorldGlintMaterialName
• getWorldMaterialName
• getWorldTextureName
• isEmpty
• isEmptyInUi
• isEmptyInWorld
• isNonExistant
• isSpriteInUi
• isSpriteInWorld
• isUsingOverrideCallback
• newTexture
• occupy
• overridesHand
• overridesUi
• queueReload
• releaseIcon
• reloadIcon
• reloadIconIfDirty
• removeModUiSpriteTexture
• setCacheKey
• setGlintMaterial
• setHandGlintMaterial
• setHandMaterial
• setHandModel
• setHandTexture
• setItemTexture
• setItemTexturePath
• setMaterial
• setModUiSpriteBitmap
• setModUiSpriteName
• setModUiSpritePath
• setModel
• setModelOverrideCallback
• setSpriteHandRender
• setSpriteUiRender
• setTexture
• setUiGlintMaterial
• setUiMaterial
• setUiModel
• setUiTexture
• updateForBlockVariant

Properties

readonlydata

data: number

Item or block data current ItemModel relates to.

readonlyid

id: number

Item or block ID current ItemModel relates to.

Methods

addToMesh

• addToMesh(mesh: RenderMesh, x: number, y: number, z: number): void

• Parameters

  • mesh: RenderMesh

  • x: number

  • y: number

  • z: number

  Returns void

getCacheKey

• getCacheKey(): string

• Returns string

getIconBitmap

• getIconBitmap(): Bitmap

• Returns Bitmap

getIconBitmapNoReload

• getIconBitmapNoReload(): Bitmap

• Returns Bitmap

getItemRenderMesh

• getItemRenderMesh(count: number, randomize: boolean): RenderMesh

• Parameters

  • count: number

  • randomize: boolean

  Returns RenderMesh

getMeshTextureName

• getMeshTextureName(): string

• Returns string

getModelForItemInstance

• getModelForItemInstance(id: number, count: number, data: number, extra: ItemExtraData): ItemModel

• Parameters

  • id: number

  • count: number

  • data: number

  • extra: ItemExtraData

  Returns ItemModel

getShaderUniforms

• getShaderUniforms(): ShaderUniformSet

• Returns ShaderUniformSet

getSpriteMesh

• getSpriteMesh(): RenderMesh

• Returns RenderMesh

getUiGlintMaterialName

• getUiGlintMaterialName(): string

• Returns string

getUiMaterialName

• getUiMaterialName(): string

• Returns string

getUiTextureName

• getUiTextureName(): string

• Returns string

getWorldGlintMaterialName

• getWorldGlintMaterialName(): string

• Returns string

getWorldMaterialName

• getWorldMaterialName(): string

• Returns string

getWorldTextureName

• getWorldTextureName(): string

• Returns string

isEmpty

• isEmpty(): boolean

• ---

  Returns boolean

  true, if the model is empty.

isEmptyInUi

• isEmptyInUi(): boolean

• Returns boolean

isEmptyInWorld

• isEmptyInWorld(): boolean

• Returns boolean

isNonExistant

• isNonExistant(): boolean

• Returns boolean

isSpriteInUi

• isSpriteInUi(): boolean

• Returns boolean

isSpriteInWorld

• isSpriteInWorld(): boolean

• Returns boolean

isUsingOverrideCallback

• isUsingOverrideCallback(): boolean

• Returns boolean

newTexture

• newTexture(): Bitmap

• Returns Bitmap

occupy

• occupy(): ItemModel

• Returns ItemModel

overridesHand

• overridesHand(): boolean

• ---

  Returns boolean

  true, if this item model overrides the default model in player's hand.

overridesUi

• overridesUi(): boolean

• ---

  Returns boolean

  true, if this item model overrides the default model in player's inventory.

queueReload

• queueReload(listener?: IconRebuildListener): Bitmap

• Parameters

  • optionallistener: IconRebuildListener

  Returns Bitmap

releaseIcon

• releaseIcon(): void

• Returns void

reloadIcon

• reloadIcon(): void

• Returns void

reloadIconIfDirty

• reloadIconIfDirty(): void

• Returns void

removeModUiSpriteTexture

• removeModUiSpriteTexture(): ItemModel

• Returns ItemModel

setCacheKey

• setCacheKey(key: string): void

• Parameters

  • key: string

  Returns void

setGlintMaterial

• setGlintMaterial(material: string): ItemModel

• Parameters

  • material: string

  Returns ItemModel

setHandGlintMaterial

• setHandGlintMaterial(material: string): ItemModel

• Parameters

  • material: string

  Returns ItemModel

setHandMaterial

• setHandMaterial(texture: string): ItemModel

• Sets item model's material only in player's hand.

  ---

  Parameters

  • texture: string

    material name to be used for the model

  Returns ItemModel

setHandModel

• setHandModel(model: RenderMesh | Model | Model, texture?: string, material?: string): ItemModel

• Sets item's model to display only in player's hand.

  ---

  Parameters

  • model: RenderMesh | Model | Model

    RenderMesh, ICRender.Model or BlockRenderer.Model to be used as item model

  • optionaltexture: string

    texture name to be used for the model (use "atlas::terrain" for block textures)

  • optionalmaterial: string

    material name to be used for the model

  Returns ItemModel

setHandTexture

• setHandTexture(texture: string): ItemModel

• Sets item model's texture only in player's hand.

  ---

  Parameters

  • texture: string

    texture name to be used for the model (use "atlas::terrain" for block textures)

  Returns ItemModel

setItemTexture

• setItemTexture(name: string, index: number): ItemModel

• Parameters

  • name: string

  • index: number

  Returns ItemModel

setItemTexturePath

• setItemTexturePath(path: string): ItemModel

• Parameters

  • path: string

  Returns ItemModel

setMaterial

• setMaterial(texture: string): ItemModel

• Sets item model's material in both player's inventory and in hand.

  ---

  Parameters

  • texture: string

    material name to be used for the model.

  Returns ItemModel

setModUiSpriteBitmap

• setModUiSpriteBitmap(bitmap: Bitmap): ItemModel

• Parameters

  • bitmap: Bitmap

  Returns ItemModel

setModUiSpriteName

• setModUiSpriteName(name: string, index: number): ItemModel

• Parameters

  • name: string

  • index: number

  Returns ItemModel

setModUiSpritePath

• setModUiSpritePath(path: string): ItemModel

• Parameters

  • path: string

  Returns ItemModel

setModel

• setModel(model: RenderMesh | Model | Model, texture?: string, material?: string): ItemModel

• Sets item's model to display both in the inventory and in hand.

  ---

  Parameters

  • model: RenderMesh | Model | Model

    RenderMesh, ICRender.Model or BlockRenderer.Model to be used as item model

  • optionaltexture: string

    texture name to be used for the model (use "atlas::terrain" for block textures)

  • optionalmaterial: string

    material name to be used for the model

  Returns ItemModel

setModelOverrideCallback

• setModelOverrideCallback(callback: ModelOverrideFunction): ItemModel

• @since

  2.0.5b45

  ---

  Parameters

  • callback: ModelOverrideFunction

  Returns ItemModel

setSpriteHandRender

• setSpriteHandRender(isSprite: boolean): ItemModel

• Determines whether an item being held in the hand should be displayed as a sprite, or if a model should be used instead, which can be particularly relevant for items such as blocks.

  @since

  2.3.1b115

  ---

  Parameters

  • isSprite: boolean

  Returns ItemModel

setSpriteUiRender

• setSpriteUiRender(isSprite: boolean): ItemModel

• Determines whether an item should be displayed as a sprite within inventory, or if a model should be used instead, which can be particularly relevant for items such as blocks.

  ---

  Parameters

  • isSprite: boolean

  Returns ItemModel

setTexture

• setTexture(texture: string): ItemModel

• Sets item model's texture in both player's inventory and in hand.

  ---

  Parameters

  • texture: string

    texture name to be used for the model (use "atlas::terrain" for block textures)

  Returns ItemModel

setUiGlintMaterial

• setUiGlintMaterial(material: string): ItemModel

• Parameters

  • material: string

  Returns ItemModel

setUiMaterial

• setUiMaterial(texture: string): ItemModel

• Sets item model's material only in player's inventory.

  ---

  Parameters

  • texture: string

    material name to be used for the model

  Returns ItemModel

setUiModel

• setUiModel(model: RenderMesh | Model | Model, texture?: string, material?: string): ItemModel

• Sets item's model to display only in player's inventory.

  ---

  Parameters

  • model: RenderMesh | Model | Model

    RenderMesh, ICRender.Model or BlockRenderer.Model to be used as item model

  • optionaltexture: string

    texture name to be used for the model (use "atlas::terrain" for block textures)

  • optionalmaterial: string

    material name to be used for the model

  Returns ItemModel

setUiTexture

• setUiTexture(texture: string): ItemModel

• Sets item model's texture only in player's inventory.

  ---

  Parameters

  • texture: string

    texture name to be used for the model (use "atlas::terrain" for block textures)

  Returns ItemModel

updateForBlockVariant

• updateForBlockVariant(variant: any): void

• Parameters

  • variant: any

  Returns void