Package dev.twilite.game.loadout

Class EquipmentLoadout

java.lang.Object

dev.twilite.game.loadout.EquipmentLoadout

All Implemented Interfaces:

Iterable<LoadoutItem>

public class EquipmentLoadout
extends Object
implements Iterable<LoadoutItem>

Item-id based equipment loadout.

Constructor Summary

Constructors

Constructor	Description
EquipmentLoadout()

Method Summary

Modifier and Type	Method	Description
EquipmentLoadout	add(EquipmentSlot slot, int id)	Adds a required item for an equipment slot.
EquipmentLoadout	add(EquipmentSlot slot, int... ids)	Adds accepted variant ids for an equipment slot.
EquipmentLoadout	add(LoadoutItem item)	Adds an equipment entry.
boolean	available()	Returns whether every required entry is worn or carried.
static EquipmentLoadout	create()	Creates an empty equipment loadout.
static EquipmentLoadout	current()	Creates an equipment loadout from the currently worn equipment.
boolean	empty()	Returns whether no entries have been added.
void	equip()	Equips any carried items that are not already worn.
Optional<LoadoutItem>	item(EquipmentSlot slot)	Returns the entry assigned to a slot.
Collection<LoadoutItem>	items()	Returns the entries in equipment-slot order.
Iterator<LoadoutItem>	iterator()
List<LoadoutItem>	missing()	Returns missing required equipment entries.
boolean	worn()	Returns whether every required entry is worn.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

EquipmentLoadout

public EquipmentLoadout()

Method Details

create

public static EquipmentLoadout create()

Creates an empty equipment loadout.

current

public static EquipmentLoadout current()

Creates an equipment loadout from the currently worn equipment.

add

public EquipmentLoadout add(LoadoutItem item)

Adds an equipment entry.

add

public EquipmentLoadout add(EquipmentSlot slot,
 int id)

Adds a required item for an equipment slot.

add

public EquipmentLoadout add(EquipmentSlot slot,
 int... ids)

Adds accepted variant ids for an equipment slot.

item

public Optional<LoadoutItem> item(EquipmentSlot slot)

Returns the entry assigned to a slot.

missing

public List<LoadoutItem> missing()

Returns missing required equipment entries.

available

public boolean available()

Returns whether every required entry is worn or carried.

worn

public boolean worn()

Returns whether every required entry is worn.

equip

public void equip()

Equips any carried items that are not already worn.

empty

public boolean empty()

Returns whether no entries have been added.

items

public Collection<LoadoutItem> items()

Returns the entries in equipment-slot order.

iterator

public Iterator<LoadoutItem> iterator()

Specified by:

iterator in interface Iterable<LoadoutItem>