EquipmentSystem

Equipment system managing designated slots (mainHand, offHand, armor, accessory), stat modifier binding to Combatant/Stats, and incompatible slot rejection.

Constructor

new EquipmentSystem(configopt)

Parameters:
NameTypeAttributesDescription
configObject<optional>

Classes

EquipmentSystem

Methods

bindTarget(target) → {EquipmentSystem}

Bind a Combatant, Stats, or composite target to receive equipment stat modifiers.

Parameters:
NameTypeDescription
targetObject
Returns:
Type: 
EquipmentSystem

canEquip(slot, item) → {boolean}

Check if an item can be equipped into a designated slot. Rejects incompatible items, consumables, or unknown slots.

Parameters:
NameTypeDescription
slotstring
itemObject
Returns:
Type: 
boolean

createSnapshot() → {Object}

Create persistence snapshot of equipped items.

Returns:
Type: 
Object

equip(slotOrItem, maybeItemopt, optionsopt) → {Object|boolean}

Equip an item into a designated slot. Modifies bound Combatant/Stats and reverts previous item stats if replacing. Rejects incompatible slots.

Parameters:
NameTypeAttributesDescription
slotOrItemstring | Object
maybeItemObject<optional>
optionsObject<optional>
Returns:

Returns previous item or equipped item on success, false on rejection.

Type: 
Object | boolean

getAllStatModifiers() → {Object}

Compute aggregate stat modifiers across all equipped items.

Returns:
Type: 
Object

getEquippedItem(slot) → {Object|null}

Alias for getSlot.

Parameters:
NameTypeDescription
slotstring
Returns:
Type: 
Object | null

getSlot(slot) → {Object|null}

Get item in a designated slot.

Parameters:
NameTypeDescription
slotstring
Returns:
Type: 
Object | null

getStatModifier(statName) → {number}

Compute total stat modifier for a specific stat across all equipped items.

Parameters:
NameTypeDescription
statNamestring
Returns:
Type: 
number

loadJSON(data)

Load from JSON representation.

Parameters:
NameTypeDescription
dataObject

normalizeSlot(slot) → {string|null}

Normalize slot name, mapping aliases like 'hand' or 'weapon' to 'mainHand'.

Parameters:
NameTypeDescription
slotstring
Returns:
Type: 
string | null

restoreSnapshot(snapshot, optionsopt) → {boolean}

Restore equipped items from snapshot, maintaining stat modifier binding.

Parameters:
NameTypeAttributesDescription
snapshotObject
optionsObject<optional>
Returns:
Type: 
boolean

toJSON() → {Object}

Export to plain JSON representation.

Returns:
Type: 
Object

unbindTarget() → {boolean}

Unbind current target, reverting any applied stat modifiers.

Returns:
Type: 
boolean

unequip(slot, optionsopt) → {Object|null}

Unequip item from a designated slot, reverting stats on bound Combatant/Stats.

Parameters:
NameTypeAttributesDescription
slotstring
optionsObject<optional>
Returns:

Unequipped item or null if slot was empty.

Type: 
Object | null