NamedLoadoutItem
A loadout item matched by item names.
ClassRLPlugins API
public class NamedLoadoutItem extends LoadoutItemMembers
Methods
- NamedLoadoutItem.Builderbuilder()
Builder.
- List<ItemEx>getBanked()
The banked.
- List<ItemEx>getCarried()
The carried.
- String[]getNames()
The names.
- List<ItemEx>getWorn()
The worn.
Inherited from LoadoutItem
- intgetAmount()
The amount.
- EquipmentSlotgetEquipmentSlot()
The equipment slot.
- StringgetIdentifier()
The identifier.
- intgetMinimumAmount()
The minimum amount.
- RestockConfiggetRestockConfig()
The restock config.
- booleanisCarried()
Whether carried.
- booleanisNoted()
Whether noted.
- booleanisOptional()
Whether optional.
- booleanisStackable()
Whether stackable.
- booleanisWorn()
Whether worn.
builder()static
public static NamedLoadoutItem.Builder builder()Builder.
getBanked()
public List<ItemEx> getBanked()The banked.
getCarried()
public List<ItemEx> getCarried()The carried.
getNames()
public String[] getNames()The names.
Returns
An array of accepted item names. The array should be ordered by the developer such that prioritized items appear first. This makes it optimal to deal with homogeneous items (Infernal cape > Fire cape), and items with charges or doses in their names such as potions and jewellery.
getWorn()
public List<ItemEx> getWorn()The worn.
getAmount()from LoadoutItem
public int getAmount()The amount.
Returns
The amount used in withdrawing.
getEquipmentSlot()from LoadoutItem
public EquipmentSlot getEquipmentSlot()The equipment slot.
getIdentifier()from LoadoutItem
public String getIdentifier()The identifier.
getMinimumAmount()from LoadoutItem
public int getMinimumAmount()The minimum amount.
Returns
The amount used in validations.
getRestockConfig()from LoadoutItem
public RestockConfig getRestockConfig()The restock config.
isCarried()from LoadoutItem
public boolean isCarried()Whether carried.
Returns
true if the LoadoutItem is carried. Different to getCarried in the sense that it checks for all parameters such as valid quantities.
isNoted()from LoadoutItem
public boolean isNoted()Whether noted.
isOptional()from LoadoutItem
public boolean isOptional()Whether optional.
Returns
If the item is optional or not. Items marked as optional will not be passed to the ItemDepletionListener.
isStackable()from LoadoutItem
public boolean isStackable()Whether stackable.
isWorn()from LoadoutItem
public boolean isWorn()Whether worn.
Returns
true if the LoadoutItem is worn. Different to getWorn in the sense that it checks for all parameters such as valid quantities.
Also allowed
Every class has these, as in plain Java.
equals, toString