java.lang.Object
- com.runemate.game.api.hybrid.entities.definitions.ItemDefinition
- - com.runemate.game.api.hybrid.cache.elements.CacheItemDefinition.Extended

All Implemented Interfaces:

Identifiable, Onymous

Enclosing class:

CacheItemDefinition
```
public class CacheItemDefinition.Extended
extends ItemDefinition
```

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`BORDER_BLACK`	Draw a 1px black border
`static int`	`BORDER_NONE`	Don't draw any border
`static int`	`BORDER_WHITE`	Draw a compound border: 1px black border, and then a 1px white border
`static int`	`TEXT_POLICY_NEVER`	Never render the quantity text
`static int`	`TEXT_POLICY_PREFERRED`	Always render the quantity text, as long as quantity != -1
`static int`	`TEXT_POLICY_SELECTIVE`	Render the quantity text if quantity != 1, and the item is stackable

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`Attribute`	`getAttribute(long id)`	Gets the attribute of this item with the specified id.
`java.util.List<Attribute>`	`getAttributes()`	The attributes of the item, contains things such as how much it can heal and what items are needed to create it.
`java.util.Map<java.awt.Color,java.awt.Color>`	`getColorSubstitutions()`
`ItemDefinition`	`getCosmeticBaseDefinition()`
`ItemDefinition`	`getCosmeticDefinition()`
`int`	`getCosmeticTemplateId()`
`Equipment.Slot`	`getEquipmentSlot()`	Gets the first valid equipment slot occupied by this item This is not guaranteed to be accurate (e.g Black mask will return null)
`java.util.List<java.lang.Integer>`	`getFemaleHeadModelIds()`
`java.util.List<java.lang.Integer>`	`getFemaleModelIds()`
`java.lang.String[]`	`getGroundActionArray()`	Deprecated.
`int`	`getGroundModelId()`
`int`	`getHighLevelAlchemyValue()`	Gets the high level alchemy value of the item
`int`	`getId()`	Gets the id of the item
`java.lang.String[]`	`getInventoryActionArray()`	Deprecated.
`int`	`getLowLevelAlchemyValue()`	Gets the low level alchemy value of the item
`java.util.List<java.lang.Integer>`	`getMaleHeadModelIds()`
`java.util.List<java.lang.Integer>`	`getMaleModelIds()`
`java.util.Map<Material,Material>`	`getMaterialSubstitutions()`
`int`	`getModelXScale()`
`int`	`getModelYScale()`
`int`	`getModelZScale()`
`@NonNull java.lang.String`	`getName()`
`int`	`getNotedId()`	Get the id of the item when it's noted (if available)
`ItemDefinition`	`getPlaceholderBaseDefinition()`
`ItemDefinition`	`getPlaceholderDefinition()`
`int`	`getPlaceholderId()`
`Equipment.Slot`	`getPrimaryEquipmentSlot()`	Primary equipment slot used by this item, according to the cache.
`java.lang.String[]`	`getRawGroundActions()`
`java.lang.String[]`	`getRawInventoryActions()`
`Equipment.Slot`	`getSecondaryEquipmentSlot()`
`java.lang.String`	`getShiftClickAction()`	On osrs, it returns the action that is triggered when a shift click style drop is used on this item.
`int`	`getShopValue()`	Gets the shop value of an item
`ItemDefinition`	`getSubstitution(int quantity)`
`com.runemate.game.api.hybrid.util.collections.PairList<java.lang.Integer,ItemDefinition>`	`getSubstitutions()`
`int`	`getTeamId()`
`Equipment.Slot`	`getTertiaryEquipmentSlot()`
`int`	`getUnnotedId()`	Get the id of the item when it's unnoted (if available)
`double`	`getWeight()`	Gets the weight of the item in kg.
`boolean`	`isCosmetic()`
`boolean`	`isEquipable()`
`boolean`	`isMembersOnly()`	Checks whether or not this item is members-only
`boolean`	`isNoted()`
`boolean`	`isPlaceholder()`
`boolean`	`isTradeable()`	Currently being rewritten to behave similarly to the way it's name implies and the way it used to perform.
`boolean`	`isTradeableOnMarket()`	Gets whether or not the item can be traded on the game's market in it's current state (currently, osrs and rs3 use the GrandExchange as it's market) Noted items will return false as should be expected since you're not actually buying and selling the notes themselves, but rather the items they represent/contain.
`boolean`	`isTwoHanded()`
`boolean`	`stacks()`	Gets whether or not multiple of this item will stack into a single inventory slot

Methods inherited from class com.runemate.game.api.hybrid.entities.definitions.ItemDefinition
get, get, get, get, getGroundActions, getIdPredicate, getInventoryActions, getNamePredicate, getUnnotedDefinition, getWornActions, loadAll, loadAll, toString

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - BORDER_NONE
```
public static final int BORDER_NONE
```
    Don't draw any border
    
    See Also:
    
    Constant Field Values
  - BORDER_BLACK
```
public static final int BORDER_BLACK
```
    Draw a 1px black border
    
    See Also:
    
    Constant Field Values
  - BORDER_WHITE
```
public static final int BORDER_WHITE
```
    Draw a compound border: 1px black border, and then a 1px white border
    
    See Also:
    
    Constant Field Values
  - TEXT_POLICY_NEVER
```
public static final int TEXT_POLICY_NEVER
```
    Never render the quantity text
    
    See Also:
    
    Constant Field Values
  - TEXT_POLICY_PREFERRED
```
public static final int TEXT_POLICY_PREFERRED
```
    Always render the quantity text, as long as quantity != -1
    
    See Also:
    
    Constant Field Values
  - TEXT_POLICY_SELECTIVE
```
public static final int TEXT_POLICY_SELECTIVE
```
    Render the quantity text if quantity != 1, and the item is stackable
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getModelXScale
```
public int getModelXScale()
```
  - getModelYScale
```
public int getModelYScale()
```
  - getModelZScale
```
public int getModelZScale()
```
  - getAttribute
```
public Attribute getAttribute(long id)
```
    Description copied from class: ItemDefinition
    
    Gets the attribute of this item with the specified id.
    
    Specified by:
    
    getAttribute in class ItemDefinition
  - getAttributes
```
public java.util.List<Attribute> getAttributes()
```
    Description copied from class: ItemDefinition
    
    The attributes of the item, contains things such as how much it can heal and what items are needed to create it.
    
    Specified by:
    
    getAttributes in class ItemDefinition
  - getColorSubstitutions
```
public java.util.Map<java.awt.Color,java.awt.Color> getColorSubstitutions()
```
    Specified by:
    
    getColorSubstitutions in class ItemDefinition
  - getMaterialSubstitutions
```
public java.util.Map<Material,Material> getMaterialSubstitutions()
```
    Specified by:
    
    getMaterialSubstitutions in class ItemDefinition
  - getGroundActionArray
```
@Deprecated
public java.lang.String[] getGroundActionArray()
```
    Deprecated.
  - getRawGroundActions
```
public java.lang.String[] getRawGroundActions()
```
    Specified by:
    
    getRawGroundActions in class ItemDefinition
  - getId
```
public int getId()
```
    Description copied from class: ItemDefinition
    
    Gets the id of the item
    
    Specified by:
    
    getId in interface Identifiable
    
    Specified by:
    
    getId in class ItemDefinition
  - getRawInventoryActions
```
public java.lang.String[] getRawInventoryActions()
```
    Specified by:
    
    getRawInventoryActions in class ItemDefinition
  - getInventoryActionArray
```
@Deprecated
public java.lang.String[] getInventoryActionArray()
```
    Deprecated.
  - isNoted
```
public boolean isNoted()
```
    Specified by:
    
    isNoted in class ItemDefinition
  - getUnnotedId
```
public int getUnnotedId()
```
    Description copied from class: ItemDefinition
    
    Get the id of the item when it's unnoted (if available)
    
    Specified by:
    
    getUnnotedId in class ItemDefinition
  - getNotedId
```
public int getNotedId()
```
    Description copied from class: ItemDefinition
    
    Get the id of the item when it's noted (if available)
    
    Specified by:
    
    getNotedId in class ItemDefinition
  - getCosmeticTemplateId
```
public int getCosmeticTemplateId()
```
    Specified by:
    
    getCosmeticTemplateId in class ItemDefinition
  - isCosmetic
```
public boolean isCosmetic()
```
    Specified by:
    
    isCosmetic in class ItemDefinition
  - getCosmeticDefinition
```
public ItemDefinition getCosmeticDefinition()
```
    Specified by:
    
    getCosmeticDefinition in class ItemDefinition
  - getCosmeticBaseDefinition
```
public ItemDefinition getCosmeticBaseDefinition()
```
    Specified by:
    
    getCosmeticBaseDefinition in class ItemDefinition
  - getPlaceholderId
```
public int getPlaceholderId()
```
    Specified by:
    
    getPlaceholderId in class ItemDefinition
  - getPlaceholderDefinition
```
public ItemDefinition getPlaceholderDefinition()
```
    Specified by:
    
    getPlaceholderDefinition in class ItemDefinition
  - getPlaceholderBaseDefinition
```
public ItemDefinition getPlaceholderBaseDefinition()
```
    Specified by:
    
    getPlaceholderBaseDefinition in class ItemDefinition
  - getEquipmentSlot
```
public Equipment.Slot getEquipmentSlot()
```
    Description copied from class: ItemDefinition
    
    Gets the first valid equipment slot occupied by this item This is not guaranteed to be accurate (e.g Black mask will return null)
    
    Specified by:
    
    getEquipmentSlot in class ItemDefinition
  - getPrimaryEquipmentSlot
```
@Nullable
public Equipment.Slot getPrimaryEquipmentSlot()
```
    Description copied from class: ItemDefinition
    
    Primary equipment slot used by this item, according to the cache. Items in the Equipment.Slot.HEAD contain this information in the secondary equipment slot
    
    Specified by:
    
    getPrimaryEquipmentSlot in class ItemDefinition
  - getSecondaryEquipmentSlot
```
@Nullable
public Equipment.Slot getSecondaryEquipmentSlot()
```
    Specified by:
    
    getSecondaryEquipmentSlot in class ItemDefinition
  - getTertiaryEquipmentSlot
```
@Nullable
public Equipment.Slot getTertiaryEquipmentSlot()
```
    Specified by:
    
    getTertiaryEquipmentSlot in class ItemDefinition
  - getLowLevelAlchemyValue
```
public int getLowLevelAlchemyValue()
```
    Description copied from class: ItemDefinition
    
    Gets the low level alchemy value of the item
    
    Specified by:
    
    getLowLevelAlchemyValue in class ItemDefinition
  - getHighLevelAlchemyValue
```
public int getHighLevelAlchemyValue()
```
    Description copied from class: ItemDefinition
    
    Gets the high level alchemy value of the item
    
    Specified by:
    
    getHighLevelAlchemyValue in class ItemDefinition
  - getShopValue
```
public int getShopValue()
```
    Description copied from class: ItemDefinition
    
    Gets the shop value of an item
    
    Specified by:
    
    getShopValue in class ItemDefinition
  - getGroundModelId
```
public int getGroundModelId()
```
    Specified by:
    
    getGroundModelId in class ItemDefinition
  - isEquipable
```
public boolean isEquipable()
```
    Specified by:
    
    isEquipable in class ItemDefinition
  - getWeight
```
public double getWeight()
```
    Description copied from class: ItemDefinition
    
    Gets the weight of the item in kg. Weight-reducing items will have negative weight.
    
    Specified by:
    
    getWeight in class ItemDefinition
  - getMaleModelIds
```
public java.util.List<java.lang.Integer> getMaleModelIds()
```
    Specified by:
    
    getMaleModelIds in class ItemDefinition
  - getFemaleModelIds
```
public java.util.List<java.lang.Integer> getFemaleModelIds()
```
    Specified by:
    
    getFemaleModelIds in class ItemDefinition
  - getMaleHeadModelIds
```
public java.util.List<java.lang.Integer> getMaleHeadModelIds()
```
    Specified by:
    
    getMaleHeadModelIds in class ItemDefinition
  - getFemaleHeadModelIds
```
public java.util.List<java.lang.Integer> getFemaleHeadModelIds()
```
    Specified by:
    
    getFemaleHeadModelIds in class ItemDefinition
  - isMembersOnly
```
public boolean isMembersOnly()
```
    Description copied from class: ItemDefinition
    
    Checks whether or not this item is members-only
    
    Specified by:
    
    isMembersOnly in class ItemDefinition
  - isPlaceholder
```
@OSRSOnly
public boolean isPlaceholder()
```
    Specified by:
    
    isPlaceholder in class ItemDefinition
  - isTradeable
```
public boolean isTradeable()
```
    Description copied from class: ItemDefinition
    
    Currently being rewritten to behave similarly to the way it's name implies and the way it used to perform.
    
    Specified by:
    
    isTradeable in class ItemDefinition
    
    See Also:
    
    ItemDefinition.isTradeableOnMarket()
  - isTradeableOnMarket
```
public boolean isTradeableOnMarket()
```
    Description copied from class: ItemDefinition
    
    Gets whether or not the item can be traded on the game's market in it's current state (currently, osrs and rs3 use the GrandExchange as it's market) Noted items will return false as should be expected since you're not actually buying and selling the notes themselves, but rather the items they represent/contain.
    
    Specified by:
    
    isTradeableOnMarket in class ItemDefinition
    
    Returns:
    
    true if you can buy and sell the item on the game's market in it's current state
  - isTwoHanded
```
public boolean isTwoHanded()
```
    Specified by:
    
    isTwoHanded in class ItemDefinition
  - stacks
```
public boolean stacks()
```
    Description copied from class: ItemDefinition
    
    Gets whether or not multiple of this item will stack into a single inventory slot
    
    Specified by:
    
    stacks in class ItemDefinition
    
    Returns:
    
    true if it can stack, otherwise false.
  - getTeamId
```
public int getTeamId()
```
    Specified by:
    
    getTeamId in class ItemDefinition
  - getShiftClickAction
```
@OSRSOnly
public java.lang.String getShiftClickAction()
```
    Description copied from class: ItemDefinition
    
    On osrs, it returns the action that is triggered when a shift click style drop is used on this item.
    
    Specified by:
    
    getShiftClickAction in class ItemDefinition
    
    Returns:
    
    a String or null if there is no shift click action defined.
  - getName
```
@NonNull
public @NonNull java.lang.String getName()
```
    Specified by:
    
    getName in interface Onymous
    
    Specified by:
    
    getName in class ItemDefinition
  - getSubstitutions
```
public com.runemate.game.api.hybrid.util.collections.PairList<java.lang.Integer,ItemDefinition> getSubstitutions()
```
  - getSubstitution
```
public ItemDefinition getSubstitution(int quantity)
```

Class CacheItemDefinition.Extended

Field Summary

Method Summary

Methods inherited from class com.runemate.game.api.hybrid.entities.definitions.ItemDefinition

Methods inherited from class java.lang.Object

Field Detail

BORDER_NONE

BORDER_BLACK

BORDER_WHITE

TEXT_POLICY_NEVER

TEXT_POLICY_PREFERRED

TEXT_POLICY_SELECTIVE

Method Detail

getModelXScale

getModelYScale

getModelZScale

getAttribute

getAttributes

getColorSubstitutions

getMaterialSubstitutions

getGroundActionArray

getRawGroundActions

getId

getRawInventoryActions

getInventoryActionArray

isNoted

getUnnotedId

getNotedId

getCosmeticTemplateId

isCosmetic

getCosmeticDefinition

getCosmeticBaseDefinition

getPlaceholderId

getPlaceholderDefinition

getPlaceholderBaseDefinition

getEquipmentSlot

getPrimaryEquipmentSlot

getSecondaryEquipmentSlot

getTertiaryEquipmentSlot

getLowLevelAlchemyValue

getHighLevelAlchemyValue

getShopValue

getGroundModelId

isEquipable

getWeight

getMaleModelIds

getFemaleModelIds

getMaleHeadModelIds

getFemaleHeadModelIds

isMembersOnly

isPlaceholder

isTradeable

isTradeableOnMarket

isTwoHanded

stacks

getTeamId

getShiftClickAction

getName

getSubstitutions

getSubstitution