PlayerBag

PlayerBag

The player's inventory bag. Always contains EMPTY_HANDED at index 0. One entry is "selected" — the currently wielded item.

Entries are {piece, count, ammo} objects (not Piece subclasses).

Constructor

new PlayerBag()

Source:

Classes

PlayerBag

Members

_entries :Array.<{piece: Item, count: number, ammo: number}>

Source:
Type:
  • Array.<{piece: Item, count: number, ammo: number}>

entries

Description:

  • All entries (read-only view). @returns {Array}

Source:

All entries (read-only view). @returns {Array}

Methods

_createEvent()

Description:

  • Injected by the Game controller after creation. Should return a GameEvent for the current turn.

Source:

add(item)

Source:
Parameters:
Name Type Description
item Item

addAt(item)

Source:
Parameters:
Name Type Description
item Item

contains(item)

Source:
Parameters:
Name Type Description
item Item

exchange(item) → {Item|null}

Description:

  • Exchange the current selection for a new item.

Source:
Parameters:
Name Type Description
item Item
Returns:

the item given up

Type
Item | null

find(fn)

Description:

  • Returns the first item matching predicate fn, or null.

Source:
Parameters:
Name Type Description
fn function

getByName(name)

Source:
Parameters:
Name Type Description
name string

item name or type name

getSelected()

Description:

  • The currently selected item (or EMPTY_HANDED).

Source:

isSelected()

Description:

  • True if this entry is the selected one.

Source:

remove(item)

Source:
Parameters:
Name Type Description
item Item

setEventFactory(fn)

Source:
Parameters:
Name Type Description
fn function

setInitialSelection(index)

Description:

  • Quietly set the selection index (during deserialization, no events).

Source:
Parameters:
Name Type Description
index number