JSDoc: Global

Members

autoSolve

A variable that dictates if the AI is solving the puzzle or if the user is.

Source:

sketch.js, line 59

loopSolve

Flag to see if the AI resets and continues to solve the puzzle once it has reached to goal state.

Source:

sketch.js, line 67

plates :number

A variable that dictates how many plates will be in the puzzle

Type:

number

Source:

sketch.js, line 45

solution

An array that stores a list of Pos objects which make up the solution of the puzzle from a given state.

Source:

sketch.js, line 82

solveIndex :number

Type:

number

Source:

sketch.js, line 74

topPlate :number

A variable that stores the highest value plate of the last clicked tower.

Type:

number

Source:

sketch.js, line 52

tower1 :Tower

A global variable that holds the information for the first Tower object.

Type:

Tower

Source:

sketch.js, line 16

tower2 :Tower

A global variable that holds the information for the second Tower object.

Type:

Tower

Source:

sketch.js, line 23

tower3 :Tower

A global variable that holds the information for the third Tower object.

Type:

Tower

Source:

sketch.js, line 31

towerSelected :number

A variable that holds which tower was last clicked

Type:

number

Source:

sketch.js, line 38

Methods

contains(list, pos) → {boolean}

Function to check if a pos object is in a list

Parameters:

Name	Type	Description
`list`	array	list to search through
`pos`	Pos	Pos object to locate

Source:

ai.js, line 39

Returns:

Value indicating if the object is in the list or not

Type: boolean

currentPos() → {Pos}

Function to get the current state of the towers.

Source:

sketch.js, line 197

Returns:

Pos state of the towers

Type: Pos

draw()

p5.js draw function, used to draw all towers

Source:

sketch.js, line 230

find(list, pos) → {number}

Function to find the index of a pos object in a list

Parameters:

Name	Type	Description
`list`	array	list to search through
`pos`	Pos	Pos object to locate

Source:

ai.js, line 22

Returns:

Index value of the object in the array. If the value is not in the array false will be returned.

Type: number

getNeighbours(node) → {Array.<Pos>}

Function to get the neighbouring states of a given pos.

Parameters:

Name	Type	Description
`node`	Pos	The game state whose neighbours are to be found.

Source:

ai.js, line 55

Returns:

- An array of all the neighbouring states.

Type: Array.<Pos>

keyPressed()

Function to handle key presses. Will toggle autosolve or reset towers.

Source:

sketch.js, line 174

mousePressed()

Function that determines if a mouse has been pressed or not and handles the movement of the plates between the towers.

Source:

sketch.js, line 88

setup()

p5.js setup function, used to create a canvas and instantiate the tower objects

Source:

sketch.js, line 205

solve()

Function to find the solution from the current state of the towers. If the current state is in a solution that has already been calculated the function will not recalculate the solution.

Source:

sketch.js, line 156

solveAStar() → {Array.<Pos>}

Function to solve the puzzle depending on the given starting state using the A* Algortihm.

Source:

ai.js, line 191

Returns:

An array of all the states between the starting state and the goal state.

Type: Array.<Pos>

solveBFS() → {Array.<Pos>}

Function to solve the puzzle depending on the given starting state using the Breadth First Search (BFS) Algortihm.

Source:

ai.js, line 102

Returns:

An array of all the states between the starting state and the goal state.

Type: Array.<Pos>