game-ds v0.11.3

A bunch of random utils for game development in js.

Classes

ArrayList

An array that auto grows, and is preallocated. It won't shrink, but will try to reuse empty elements if they have been removed.

Kind: global class

• ArrayList
  • new ArrayList()
  • .count ⇒ Number
  • .pullExists() ⇒ Mixed
  • .push(item)
  • .add(array)
  • .remove(fn)
  • .clear()

new ArrayList()

Constructor.

arrayList.count ⇒ Number

Count how many defined values are in the array.

Kind: instance property of ArrayList
Returns: Number - Array elements that aren't undefined.

arrayList.pullExists() ⇒ Mixed

Get and remove the first existing value in the array.

Kind: instance method of ArrayList
Returns: Mixed - Existing value.

arrayList.push(item)

Add an item to the array. Either lengthens array, or uses an "empty" index.

Kind: instance method of ArrayList

arrayList.add(array)

Add an array to the array. Either lengthens array or adds elements in "empty" indices.

Kind: instance method of ArrayList

arrayList.remove(fn)

Removes elements from the array matching the fn (returns true).

Kind: instance method of ArrayList

arrayList.clear()

Sets all current elements in array to undefined.

Kind: instance method of ArrayList

BSP

BSP

Kind: global class

• BSP
  • new BSP(height, width)
  • .makeNode(x, y, w, h, l, r) ⇒ Node
  • .makeTree(node, level)
  • .split(node)
  • .traverseInOrder(cb)
  • .traversePreOrder(cb)
  • .traversePostOrder(cb)

new BSP(height, width)

constructor

bsP.makeNode(x, y, w, h, l, r) ⇒ Node

Create a node to put into the BSP.

Kind: instance method of BSP

bsP.makeTree(node, level)

Create a tree.

Kind: instance method of BSP

bsP.split(node)

Split the given node into two child nodes.

Kind: instance method of BSP

bsP.traverseInOrder(cb)

Traverse the tree in order.

Kind: instance method of BSP

bsP.traversePreOrder(cb)

Traverse the tree pre order.

Kind: instance method of BSP

bsP.traversePostOrder(cb)

Traverse the tree post order.

Kind: instance method of BSP

Graph

A graph data structure. Undirected and using an adjacency list.

Kind: global class

• Graph
  • new Graph()
  • .addVertex(v) ⇒ *
  • .addEdge(src, dest)
  • .getNeighbors(v) ⇒ Array
  • .getWeightedNeighbors(v) ⇒ Array
  • .bfs(startingNode, cb)
  • .dfs(startingNode, cb)
  • .print()

new Graph()

constructor

graph.addVertex(v) ⇒ *

Add a vertex to the graph. If it already exists, it does nothing.

Kind: instance method of Graph
Returns: * - The added vertex.

graph.addEdge(src, dest)

Add an edge between src and dest.

Kind: instance method of Graph

graph.getNeighbors(v) ⇒ Array

Get the neighbors of the given node.

Kind: instance method of Graph
Returns: Array - The array of neighbor nodes.

graph.getWeightedNeighbors(v) ⇒ Array

Get the neighbor and wieights of the given node.

Kind: instance method of Graph
Returns: Array - The array of neighbor nodes.

graph.bfs(startingNode, cb)

A breath first search through the graph, starting at the given node.

Kind: instance method of Graph

graph.dfs(startingNode, cb)

A depth first search through the graph.

Kind: instance method of Graph

graph.print()

For debugging, prints adjacency list.

Kind: instance method of Graph

Heap

A heap implemenation.

Kind: global class

• Heap
  • new Heap(compare)
  • .push(n)
  • .pop() ⇒ *

new Heap(compare)

constructor

heap.push(n)

Push an element onto the heap.

Kind: instance method of Heap

heap.pop() ⇒ *

Remove and return the ximum element in the heap.

Kind: instance method of Heap
Returns: * - The ximum element on the heap.