List

Require

If the concord folder is in the root directory of your game, you can import this module like so:

List = require('concord.list')

new

Creates a new List.

list = List.new()

Returns

Name	Type	Description
list	List

add

Adds an object to the List.

Object must be of reference type Object may not be the string ‘size’, ‘onAdded’ or ‘onRemoved’

list = list:add( obj )

Arguments

Name	Type	Description
obj	any	Object to add

Returns

Name	Type	Description
list	List

remove

Removes an object from the List.

list:remove( obj )

Arguments

Name	Type	Description
obj	any	Object to remove

Returns

Name	Type	Description
	List|nil	Returns self if removed; nil if the object was not in the List

clear

Clears the List completely.

Does not call onRemoved.

list = list:clear()

Returns

Name	Type	Description
list	List

has

Returns true if the List has the object.

boolean = list:has( obj )

Arguments

Name	Type	Description
obj	any	Object to check for

Returns

Name	Type	Description
boolean	boolean

get

Returns the object at an index.

any = list:get( i )

Arguments

Name	Type	Description
i	integer	Index to get from

indexOf

Returns the index of an object in the List.

Errors if the object is not in the List.

integer = list:indexOf( obj )

Arguments

Name	Type	Description
obj	any	Object to get index of

Returns

Name	Type	Description
integer	integer	index of object in the List.

sort

Sorts the List in place, using the order function.

The order function is passed to table.sort internally so documentation on table.sort can be used as reference.

list = list:sort( order )

Arguments

Name	Type	Description
order	fun(a: any, b: any)	: boolean Function that takes two items (a and b) and returns true if a should go before b.

Returns

Name	Type	Description
list	List

onAdded

Callback for when an item is added to the List.

list:onAdded( obj )

Arguments

Name	Type	Description
obj	any	Object that was added

onRemoved

Callback for when an item is removed from the List.

Not called by List:clear.

list:onRemoved( obj )

Arguments

Name	Type	Description
obj	any	Object that was removed