Class: Collection

Methods

---

addItem(item, name)

Add an item with optional name

Parameters:

Name	Type	Argument	Description
item	Any		The item to add
name	String	<optional>	The optional name of the item

Source:

• Collection.js, line 59

Returns:

Type

Collection

---

addItems(items)

Add multiple items

Parameters:

Name	Type	Argument	Description
items	Object	<repeatable>	Can be the object itself or an object containing the entity and it's name eg: { item: Entity, name: 'entityName' }

Source:

• Collection.js, line 76

Returns:

Type

Collection

---

each(fn, scope)

Iterates the collection's sorted items. The item, index, and name are supplied
to the provided function

Parameters:

Name	Type	Argument	Description
fn	function		The function to execute on the iterable
scope	Object	<optional>	The scope with which to execute the function

Source:

• Collection.js, line 97

---

filter(fn, scope)

iterates items and return the ones that meet criteria

Parameters:

Name	Type	Argument	Description
fn	function		Truth predicate
scope	Object	<optional>	The scope with which to execute the function

Source:

• Collection.js, line 116

Returns:

Type

Array

---

getItem(name)

Returns an existing item by name, or undefined if the name is not found

Parameters:

Name	Type	Description
name	String	The name of the item

Source:

• Collection.js, line 147

Returns:

Type

Any

---

getItemArray()

Returns a list of just the items

Source:

• Collection.js, line 135

Returns:

Type

Array

---

getItemAt(index)

Returns an existing item by index

Parameters:

Name	Type	Description
index	Integer

Source:

• Collection.js, line 167

Returns:

Type

Any

---

getItemCount()

Returns the count of items in collection

Source:

• Collection.js, line 176

Returns:

Type

Integer

---

getItemIndex(name)

Returns an item's current index

Parameters:

Name	Type	Description
name	String

Source:

• Collection.js, line 186

Returns:

Type

Integer

---

removeAllItems()

Removes all items from collection

Source:

• Collection.js, line 203

---

setItem(name, value)

Assigns a new value to an existing item

Parameters:

Name	Type	Description
name	String	The name of the object to modify
value	Any	The new value

Source:

• Collection.js, line 237

---

setItemIndex(name, index)

Moves item to new index

Parameters:

Name	Type	Description
name	String	The name of the object being moved
index	Integer	The item's new index

Source:

• Collection.js, line 254