Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- addCell(Cell) - Method in interface com.slinky.hackmaster.model.cell.CellCluster
-
Adds a
Cell
to this cluster. - addCell(Cell) - Method in class com.slinky.hackmaster.model.cell.LetterCluster
-
Adds a
Cell
to the cluster, ensuring it is an instance ofLetterCell
. - addCell(Cell) - Method in class com.slinky.hackmaster.model.cell.SymbolCluster
-
Adds a
Cell
to theSymbolCluster
. - addClickListener(ChangeListener<? super Boolean>) - Method in class com.slinky.hackmaster.model.cell.LetterCell
-
Adds a listener that will be notified whenever the value of the `clickCount` property changes.
- addClickListener(ChangeListener<? super Boolean>) - Method in interface com.slinky.hackmaster.model.cell.Cell
-
Adds a listener that will be notified whenever the value of the `clickCount` property changes.
- addContentListener(ChangeListener<? super Character>) - Method in class com.slinky.hackmaster.model.cell.LetterCell
-
Registers a listener that will be notified when the content of the cell changes, such as when it is filled or modified.
- addContentListener(ChangeListener<? super Character>) - Method in interface com.slinky.hackmaster.model.cell.Cell
-
Registers a listener that will be notified when the content of the cell changes, such as when it is filled or modified.
- addDudCountListener(ChangeListener<? super Number>) - Method in class com.slinky.hackmaster.model.text.StaticWordSet
-
Adds a listener to monitor changes in the count of "dud" words.
- addDudCountListener(ChangeListener<? super Number>) - Method in interface com.slinky.hackmaster.model.text.WordSet
-
Adds a listener to monitor changes in the count of "dud" words.
- addGuessListener(ChangeListener<? super Number>) - Method in class com.slinky.hackmaster.model.GameState
-
Adds a listener to the guess count property.
- addStateListener(ChangeListener<? super Boolean>) - Method in class com.slinky.hackmaster.model.cell.LetterCell
-
Adds a listener to the `isActiveProperty` to monitor changes in its value.
- addStateListener(ChangeListener<? super Boolean>) - Method in interface com.slinky.hackmaster.model.cell.Cell
-
Adds a listener to the `isActiveProperty` to monitor changes in its value.
- addToCluster(CellCluster) - Method in interface com.slinky.hackmaster.model.cell.Cell
-
Adds this
Cell
to the specifiedCellCluster
. - addToCluster(CellCluster) - Method in class com.slinky.hackmaster.model.cell.LetterCell
-
Adds this
LetterCell
to the specifiedLetterCluster
. - addToCluster(CellCluster) - Method in class com.slinky.hackmaster.model.cell.SymbolCell
-
Adds this
SymbolCell
to the specifiedCellCluster
. - ADVANCED - Enum constant in enum class com.slinky.hackmaster.model.text.Difficulty
-
A challenging difficulty level for users with a good understanding of the subject.
- App - Class in com.slinky.hackmaster
-
The
App
class is the main entry point for the JavaFX-based puzzle. - App() - Constructor for class com.slinky.hackmaster.App
B
- BACKGROUND - Static variable in class com.slinky.hackmaster.model.GameConstants
-
The color for the game's background
- BEGINNER - Enum constant in enum class com.slinky.hackmaster.model.text.Difficulty
-
The easiest difficulty level, suitable for beginners.
C
- calculateSimilarity(String, String) - Static method in class com.slinky.hackmaster.util.StringUtil
-
Calculates the similarity between two strings by counting the number of matching characters at the same positions in both strings.
- Cell - Interface in com.slinky.hackmaster.model.cell
-
Represents the fundamental interactive unit within the game.
- CELL_HEIGHT - Static variable in class com.slinky.hackmaster.model.GameConstants
-
The constant height of the cell view in pixels.
- CELL_WIDTH - Static variable in class com.slinky.hackmaster.model.GameConstants
-
The constant width of the cell view in pixels.
- Cell.IllegalCharAddition - Exception in com.slinky.hackmaster.model.cell
-
The
IllegalCharAddition
class is a specific type ofIllegalArgumentException
that is thrown when an invalid character is added to a cell. - CellCluster - Interface in com.slinky.hackmaster.model.cell
-
The
CellCluster
interface defines the contract for managing a collection ofCell
objects within the context of the hacking mini-game. - CellCluster.ClusterCloseException - Exception in com.slinky.hackmaster.model.cell
-
The
ClusterCloseException
class represents an exception that is thrown when there is an issue closing a cell cluster within the hacking mini-game grid. - CellGrid - Class in com.slinky.hackmaster.model.cell
-
The
CellGrid
class is responsible for managing a grid ofCell
objects, including their creation, clustering, and global operations. - CellGrid(String, ClusterStrategy) - Constructor for class com.slinky.hackmaster.model.cell.CellGrid
-
Constructs a new
CellGrid
with the specified text grid and clustering strategy. - CellGrid(String, ClusterStrategy, int, int) - Constructor for class com.slinky.hackmaster.model.cell.CellGrid
-
Constructs a new
CellGrid
with the specified text grid and clustering strategy. - CellManager - Interface in com.slinky.hackmaster.model.cell
-
The
CellManager
interface defines the operations that any class must implement to manageCell
objects. - CellPanel(CellView[][]) - Constructor for class com.slinky.hackmaster.view.CenterPanel.CellPanel
-
Constructs a
CellPanel
with the specified grid ofCellView
objects. - CellView - Class in com.slinky.hackmaster.view
-
The
CellView
class is a graphical representation of aCell
object within the JavaFX framework. - CellView(Cell) - Constructor for class com.slinky.hackmaster.view.CellView
-
Constructs a new
CellView
for the specifiedCell
. - CenterPanel - Class in com.slinky.hackmaster.view
-
A custom panel that extends
HBox
to organise and display twoCenterPanel.HexPanel
instances and twoCenterPanel.CellPanel
instances. - CenterPanel(CellView[][]) - Constructor for class com.slinky.hackmaster.view.CenterPanel
-
Constructs a
CenterPanel
with the specified grid ofCellView
objects. - CenterPanel.CellPanel - Class in com.slinky.hackmaster.view
-
A custom panel that extends
TilePane
to display a grid ofCellView
objects. - CenterPanel.HexPanel - Class in com.slinky.hackmaster.view
-
A custom panel that extends
VBox
to display a series of hexadecimal values. - clear() - Method in class com.slinky.hackmaster.model.cell.LetterCluster
-
Clears all internal
Cell
references if the cluster has not yet been closed. - clear() - Method in interface com.slinky.hackmaster.model.cell.CellCluster
-
Clears all cells from the cluster.
- clear() - Method in class com.slinky.hackmaster.view.TerminalPanel
-
Clears all text from the terminal panel.
- click() - Method in class com.slinky.hackmaster.model.cell.LetterCell
-
Toggles the value of the `clickProperty`, thereby triggering any event listeners that are bound to this property.
- click() - Method in class com.slinky.hackmaster.model.cell.SymbolCluster
-
Handles the internal behaviour triggered by a click on this cluster.
- click() - Method in interface com.slinky.hackmaster.model.cell.Cell
-
Handles the internal behaviour triggered by a click on this cell.
- click() - Method in interface com.slinky.hackmaster.model.cell.CellCluster
-
Handles the internal behaviour triggered by a click on this cluster.
- click() - Method in class com.slinky.hackmaster.model.cell.LetterCluster
-
Handles the internal behaviour triggered by a click on this cluster.
- close() - Method in class com.slinky.hackmaster.model.cell.LetterCluster
-
Closes the cluster, marking it as complete and preventing any further modifications such as adding, removing, or clearing cells within the cluster.
- close() - Method in interface com.slinky.hackmaster.model.cell.CellCluster
-
Closes and validates the cluster, meaning no more cells can be added, removed, or cleared.
- CLOSE_TYPES - Static variable in class com.slinky.hackmaster.model.cell.SymbolCell
-
Characters that are considered as closing brackets.
- ClusterCloseException(CellCluster, String) - Constructor for exception com.slinky.hackmaster.model.cell.CellCluster.ClusterCloseException
-
Constructs a new
ClusterCloseException
with the specified detail message. - clusterLetters(Collection<? extends Cell>) - Method in interface com.slinky.hackmaster.model.cell.ClusterStrategy
-
Clusters a given collection of
LetterCell
s into one or moreCellCluster
s based on the implemented strategy. - clusterLetters(Collection<? extends Cell>) - Method in class com.slinky.hackmaster.model.cell.ExhaustiveClusterStrategy
-
Linearly searches through each
Cell
and groups consecutiveLetterCell
s intoLetterCluster
s. - ClusterStrategy - Interface in com.slinky.hackmaster.model.cell
-
Strategy interface for clustering
SymbolCell
s andLetterCell
s into one or moreCellCluster
s based on the implemented strategy. - clusterSymbols(Collection<? extends Cell>) - Method in interface com.slinky.hackmaster.model.cell.ClusterStrategy
-
Clusters a given collection of
SymbolCell
s into one or moreCellCluster
s based on the implemented strategy. - clusterSymbols(Collection<? extends Cell>) - Method in class com.slinky.hackmaster.model.cell.ExhaustiveClusterStrategy
-
Clusters symbols in a given collection of
Cell
objects based on matching open and close bracket types. - colorToRgbString(Color) - Static method in class com.slinky.hackmaster.util.StringUtil
-
Converts a
Color
object into its RGB string representation. - com.slinky.hackmaster - module com.slinky.hackmaster
-
Provides an implementation of the Fallout Hacking Puzzle.
- com.slinky.hackmaster - package com.slinky.hackmaster
- com.slinky.hackmaster.controller - package com.slinky.hackmaster.controller
- com.slinky.hackmaster.model - package com.slinky.hackmaster.model
- com.slinky.hackmaster.model.cell - package com.slinky.hackmaster.model.cell
- com.slinky.hackmaster.model.text - package com.slinky.hackmaster.model.text
- com.slinky.hackmaster.util - package com.slinky.hackmaster.util
- com.slinky.hackmaster.view - package com.slinky.hackmaster.view
- contains(Cell) - Method in class com.slinky.hackmaster.model.cell.LetterCluster
-
Checks if the cluster contains a specific
Cell
. - contains(Cell) - Method in interface com.slinky.hackmaster.model.cell.CellCluster
-
Determines if the given
Cell
argument belongs to this cluster - countCharacters(String[]) - Static method in class com.slinky.hackmaster.util.StringUtil
-
Calculates and returns the total number of characters across all words in the word list.
- createGameState(WordSet, int) - Static method in class com.slinky.hackmaster.model.GameState
-
Creates the singleton instance of
GameState
with the providedWordSet
and starting number of guesses.
D
- decrementGuesses() - Method in class com.slinky.hackmaster.model.GameState
-
Decreases the current guess count by one.
- Difficulty - Enum Class in com.slinky.hackmaster.model.text
-
The
Difficulty
enum defines five distinct levels of difficulty for categorising word lists within the application. - Dimension - Record Class in com.slinky.hackmaster.util
-
The
Dimension
record represents a two-dimensional measurement withwidth
andheight
components. - Dimension(int, int) - Constructor for record class com.slinky.hackmaster.util.Dimension
-
Creates an instance of a
Dimension
record class. - display(String) - Method in class com.slinky.hackmaster.view.MainView
-
Displays the specified text in the terminal panel.
- display(String) - Method in class com.slinky.hackmaster.view.TerminalPanel
-
Displays the specified text in the terminal panel.
- drawNext() - Method in class com.slinky.hackmaster.view.InfiniteCurveCanvas
-
Draws the next line segment of the Hilbert Curve on the canvas.
E
- equals(Object) - Method in record class com.slinky.hackmaster.util.Dimension
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.slinky.hackmaster.util.Point
-
Indicates whether some other object is "equal to" this one.
- ExhaustiveClusterStrategy - Class in com.slinky.hackmaster.model.cell
-
A strategy for clustering symbols and letters within a collection of
Cell
objects. - ExhaustiveClusterStrategy(int) - Constructor for class com.slinky.hackmaster.model.cell.ExhaustiveClusterStrategy
-
Constructs a new
SimpleClusterStrategy
with the specified number of columns. - EXPERT - Enum constant in enum class com.slinky.hackmaster.model.text.Difficulty
-
A high difficulty level, designed for experts.
F
- fill(char) - Method in class com.slinky.hackmaster.model.cell.LetterCluster
-
Sets the content of each
Cell
within this cluster to the specified character. - fill(char) - Method in interface com.slinky.hackmaster.model.cell.CellCluster
-
Sets the content of each cell in the cluster to the specified character.
- FONT - Static variable in class com.slinky.hackmaster.model.GameConstants
-
The
Font
object representing the font used in the application. - FONT_SIZE - Static variable in class com.slinky.hackmaster.model.GameConstants
-
The default font size used for the
Font
object in the application. - forceClear() - Method in class com.slinky.hackmaster.model.cell.LetterCluster
-
Forcefully clears all internal
Cell
references, regardless of the cluster's state. - forceClear() - Method in interface com.slinky.hackmaster.model.cell.CellCluster
-
Forces the cluster to clear regardless of its state, removing all
Cell
references within the internal collection. - FOREGROUND - Static variable in class com.slinky.hackmaster.model.GameConstants
-
The main foreground to be used throughout the game.
G
- GameConstants - Class in com.slinky.hackmaster.model
-
The
GameConstants
class defines a set of constants used throughout the game application. - GameConstants() - Constructor for class com.slinky.hackmaster.model.GameConstants
- GameState - Class in com.slinky.hackmaster.model
-
The
GameState
class represents the state of the game and serves as the model for the application. - GameState(WordSet) - Constructor for class com.slinky.hackmaster.model.GameState
-
Constructs a new
GameState
object with the specified word set and starting number of guesses. - getCell() - Method in class com.slinky.hackmaster.view.CellView
-
Retrieves the
Cell
associated with thisCellView
. - getCell(int) - Method in class com.slinky.hackmaster.model.cell.CellGrid
-
Retrieves the
Cell
at the specified index from the internal cell array. - getCell(int) - Method in interface com.slinky.hackmaster.model.cell.CellManager
-
Retrieves a
Cell
at the specified index. - getCellAt(int) - Method in class com.slinky.hackmaster.model.cell.LetterCluster
-
Retrieves the
Cell
at the specified index within the cluster. - getCellAt(int) - Method in interface com.slinky.hackmaster.model.cell.CellCluster
-
Retrieves the Cell at the specified index.
- getCellAt(int, int) - Method in class com.slinky.hackmaster.model.cell.CellGrid
-
Returns the
Cell
located at the specified row and column in the grid. - getCellAt(int, int) - Method in interface com.slinky.hackmaster.model.cell.CellManager
-
Returns the
Cell
located at the specified row and column in the grid. - getCellDisplays() - Method in class com.slinky.hackmaster.view.CenterPanel.CellPanel
-
Returns the grid of
CellView
objects managed by this panel. - getCells() - Method in class com.slinky.hackmaster.model.cell.LetterCluster
-
Retrieves the list of
Cell
s in the cluster. - getCells() - Method in interface com.slinky.hackmaster.model.cell.CellCluster
-
All Cells in this cluster.
- getCells() - Method in class com.slinky.hackmaster.model.cell.CellGrid
-
Returns a flat array of all the
Cell
objects in the grid. - getCells() - Method in interface com.slinky.hackmaster.model.cell.CellManager
-
Retrieves an array of all
Cell
objects managed by thisCellManager
. - getCells2D() - Method in class com.slinky.hackmaster.model.cell.CellGrid
-
Returns the 2D arrangement of Cells.
- getCells2D() - Method in interface com.slinky.hackmaster.model.cell.CellManager
-
Returns the 2D arrangement of Cells.
- getClosestRowColPair(int) - Static method in class com.slinky.hackmaster.util.GridUtil
-
Computes and returns the closest pair of factors for a given integer
x
. - getCloseType() - Method in class com.slinky.hackmaster.model.cell.SymbolCell
-
Gets the type index of the closing bracket contained in the cell.
- getColumnCount() - Method in class com.slinky.hackmaster.model.cell.CellGrid
-
Retrieves the number of columns in the grid.
- getContent() - Method in class com.slinky.hackmaster.model.cell.LetterCell
-
Retrieves the character content of this cell.
- getContent() - Method in interface com.slinky.hackmaster.model.cell.Cell
-
Retrieves the content (a character) contained within this
Cell
. - getCorrectWord() - Method in class com.slinky.hackmaster.model.GameState
-
Returns the correct word that the player needs to guess.
- getCorrectWord() - Method in class com.slinky.hackmaster.model.text.StaticWordSet
-
Retrieves the correct word from the word set.
- getCorrectWord() - Method in interface com.slinky.hackmaster.model.text.WordSet
-
Retrieves the correct word from the word set.
- getFirstCell() - Method in class com.slinky.hackmaster.model.cell.LetterCluster
-
Retrieves the first
Cell
in the cluster. - getFirstCell() - Method in interface com.slinky.hackmaster.model.cell.CellCluster
-
Retrieves the first cell in the cluster.
- getGameState() - Static method in class com.slinky.hackmaster.model.GameState
-
Retrieves the singleton instance of
GameState
. - getGuessCount() - Method in class com.slinky.hackmaster.model.GameState
-
Retrieves the current number of guesses remaining for the player.
- getIndexOf(Cell) - Method in class com.slinky.hackmaster.model.cell.LetterCluster
-
Retrieves the index of the specified
Cell
within the cluster. - getIndexOf(Cell) - Method in interface com.slinky.hackmaster.model.cell.CellCluster
-
Retrieves the index of a specific cell within the cluster.
- getLastCell() - Method in class com.slinky.hackmaster.model.cell.LetterCluster
-
Retrieves the last
Cell
in the cluster. - getLastCell() - Method in interface com.slinky.hackmaster.model.cell.CellCluster
-
Retrieves the last cell in the cluster.
- getLastHexValue() - Method in class com.slinky.hackmaster.view.CenterPanel.HexPanel
-
Returns the last or current hexadecimal value, represented in base 10 notation.
- getLetterClusters() - Method in class com.slinky.hackmaster.model.cell.CellGrid
-
Returns the list of letter clusters in the grid.
- getLetterClusters() - Method in interface com.slinky.hackmaster.model.cell.CellManager
-
Retrieves a list of
CellCluster
objects that represent clusters of letter cells. - getMainCluster() - Method in interface com.slinky.hackmaster.model.cell.Cell
-
Retrieves the primary cluster that this
Cell
is associated with. - getMainCluster() - Method in class com.slinky.hackmaster.model.cell.LetterCell
-
Returns the
CellCluster
instance that thisLetterCell
currently belongs to. - getMainCluster() - Method in class com.slinky.hackmaster.model.cell.SymbolCell
-
Returns the
CellCluster
where thisSymbolCell
is the first cell in the cluster. - getMainCluster() - Method in class com.slinky.hackmaster.view.CellView
-
Retrieves the main
CellCluster
to which the associatedCell
belongs. - getMessage() - Method in class com.slinky.hackmaster.view.LockedOutScreen
- getOpenType() - Method in class com.slinky.hackmaster.model.cell.SymbolCell
-
Gets the type index of the opening bracket contained in the cell.
- getRowCount() - Method in class com.slinky.hackmaster.model.cell.CellGrid
-
Retrieves the number of rows in the grid.
- getSize() - Method in class com.slinky.hackmaster.model.cell.LetterCluster
-
Returns the number of
Cell
s in the cluster. - getSize() - Method in interface com.slinky.hackmaster.model.cell.CellCluster
-
Retrieves the size of the cluster, which is the number of cells it contains.
- getSymbolClusters() - Method in class com.slinky.hackmaster.model.cell.CellGrid
-
Returns the list of symbol clusters in the grid.
- getSymbolClusters() - Method in interface com.slinky.hackmaster.model.cell.CellManager
-
Retrieves a list of
CellCluster
objects that represent clusters of symbol cells. - getText() - Method in class com.slinky.hackmaster.model.cell.LetterCluster
-
Concatenates the content of all
Cell
s in the cluster into a single string. - getText() - Method in interface com.slinky.hackmaster.model.cell.CellCluster
-
Concatenates each cell's content into a single string and returns it.
- getTotalCharacters() - Method in class com.slinky.hackmaster.model.text.StaticWordSet
-
Calculates and returns the total number of characters across all words in the word list.
- getTotalCharacters() - Method in interface com.slinky.hackmaster.model.text.WordSet
-
Calculates and returns the total number of characters across all words in the word list.
- getWords() - Method in class com.slinky.hackmaster.model.cell.CellGrid
-
Returns an array of words formed by the letter clusters in the grid.
- getWords() - Method in interface com.slinky.hackmaster.model.cell.CellManager
-
Retrieves an array of words formed by the managed cells.
- getWordSet() - Method in class com.slinky.hackmaster.model.GameState
-
Retrieves the
WordSet
currently used in this game session. - getWordSet(Difficulty) - Static method in class com.slinky.hackmaster.model.text.WordBank
-
Returns the word list for the specified difficulty level.
- GridUtil - Class in com.slinky.hackmaster.util
-
A comprehensive utility class designed for performing various operations on 2D arrays in Java.
H
- hashCode() - Method in record class com.slinky.hackmaster.util.Dimension
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.slinky.hackmaster.util.Point
-
Returns a hash code value for this object.
- height() - Method in record class com.slinky.hackmaster.util.Dimension
-
Returns the value of the
height
record component. - HexPanel(int) - Constructor for class com.slinky.hackmaster.view.CenterPanel.HexPanel
-
Constructs a
HexPanel
with the specified number of rows, starting with a random hexadecimal value. - HexPanel(int, int) - Constructor for class com.slinky.hackmaster.view.CenterPanel.HexPanel
-
Constructs a
HexPanel
with the specified number of rows, starting with the given hexadecimal value.
I
- IllegalCharAddition(String) - Constructor for exception com.slinky.hackmaster.model.cell.Cell.IllegalCharAddition
-
Constructs a new
IllegalCharAddition
with the specified detail message. - IllegalCharAddition(String, Throwable) - Constructor for exception com.slinky.hackmaster.model.cell.Cell.IllegalCharAddition
-
Constructs a new
IllegalCharAddition
with the specified detail message and cause. - IllegalCharAddition(Throwable) - Constructor for exception com.slinky.hackmaster.model.cell.Cell.IllegalCharAddition
-
Constructs a new
IllegalCharAddition
with the specified cause. - inActiveCluster() - Method in interface com.slinky.hackmaster.model.cell.Cell
-
Checks if the cell is part of an active cluster.
- inActiveCluster() - Method in class com.slinky.hackmaster.model.cell.LetterCell
-
Checks whether the cluster this
LetterCell
belongs to is currently active. - inActiveCluster() - Method in class com.slinky.hackmaster.model.cell.SymbolCell
-
Checks if this
SymbolCell
is part of an activeCellCluster
. - inCluster() - Method in interface com.slinky.hackmaster.model.cell.Cell
-
Checks if the cell is part of a cluster.
- inCluster() - Method in class com.slinky.hackmaster.model.cell.LetterCell
-
Indicates whether this
LetterCell
is part of aLetterCluster
. - inCluster() - Method in class com.slinky.hackmaster.model.cell.SymbolCell
-
Checks if this
SymbolCell
is part of anyCellCluster
. - incrementGuesses() - Method in class com.slinky.hackmaster.model.GameState
-
Increases the current guess count by one.
- InfiniteCurveCanvas - Class in com.slinky.hackmaster.view
-
The
InfiniteCurveCanvas
class is a custom implementation of theCanvas
component that animates the drawing of the Hilbert Curve, a type of space-filling curve. - InfiniteCurveCanvas(int, int) - Constructor for class com.slinky.hackmaster.view.InfiniteCurveCanvas
-
Constructs an
InfiniteCurveCanvas
with the specified width and height. - init() - Method in class com.slinky.hackmaster.App
-
Initialises the application.
- INTERMEDIATE - Enum constant in enum class com.slinky.hackmaster.model.text.Difficulty
-
A step up in difficulty, aimed at those with basic knowledge.
- isActive() - Method in class com.slinky.hackmaster.model.cell.LetterCell
-
Checks if the cell is currently active.
- isActive() - Method in class com.slinky.hackmaster.model.cell.LetterCluster
-
Checks if the cluster is currently active.
- isActive() - Method in interface com.slinky.hackmaster.model.cell.Cell
-
Checks if the cell is currently active.
- isActive() - Method in interface com.slinky.hackmaster.model.cell.CellCluster
-
Checks if the cluster is currently active.
- isClosed() - Method in class com.slinky.hackmaster.model.cell.LetterCluster
-
Checks if the cluster has been closed.
- isClosed() - Method in interface com.slinky.hackmaster.model.cell.CellCluster
-
Checks if the cluster is closed.
- isCloseType() - Method in class com.slinky.hackmaster.model.cell.SymbolCell
-
Checks if the cell contains a closing bracket type.
- isEmpty() - Method in class com.slinky.hackmaster.model.cell.LetterCluster
-
Checks if the cluster is empty.
- isEmpty() - Method in interface com.slinky.hackmaster.model.cell.CellCluster
-
Checks if the cluster is empty, i.e., contains no cells.
- isOpenType() - Method in class com.slinky.hackmaster.model.cell.SymbolCell
-
Checks if the cell contains an opening bracket type.
- isRectangular(T[][]) - Static method in class com.slinky.hackmaster.util.GridUtil
-
Checks if the provided 2D array is rectangular (i.e., all rows have the same length).
J
- jumble(int) - Method in class com.slinky.hackmaster.model.text.StaticWordSet
-
Generates a string with the specified size, inserting random symbols between the words.
- jumble(int) - Method in interface com.slinky.hackmaster.model.text.WordSet
-
Generates a string of the specified size by inserting random symbols between the words.
- jumble(String[], int) - Method in interface com.slinky.hackmaster.model.text.JumbleStrategy
-
Generates a jumbled version of the provided string by inserting random symbols to meet the specified size.
- jumble(String[], int) - Method in class com.slinky.hackmaster.model.text.SimpleJumbleStrategy
-
Generates a string with the specified size, inserting random symbols between the words.
- JumbleStrategy - Interface in com.slinky.hackmaster.model.text
-
Provides a strategy for generating a jumbled string from the provided text and specified size.
L
- LetterCell - Class in com.slinky.hackmaster.model.cell
-
Represents a cell that contains a single alphabetic character within a grid or similar structure.
- LetterCell(char) - Constructor for class com.slinky.hackmaster.model.cell.LetterCell
-
Constructs a new
LetterCell
with the specified content. - LetterCluster - Class in com.slinky.hackmaster.model.cell
-
A specialised implementation of
AbstractCluster
that groupsLetterCell
s. - LetterCluster() - Constructor for class com.slinky.hackmaster.model.cell.LetterCluster
- LockedOutScreen - Class in com.slinky.hackmaster.view
- LockedOutScreen(String) - Constructor for class com.slinky.hackmaster.view.LockedOutScreen
M
- main(String[]) - Static method in class com.slinky.hackmaster.App
-
The main method that serves as the entry point for the application.
- MainController - Class in com.slinky.hackmaster.controller
-
The
MainController
class serves as the central controller within the game, managing the interactions between the game's view (UI) components and the underlying game logic and data models. - MainController(CellManager, MainView, WordSet) - Constructor for class com.slinky.hackmaster.controller.MainController
-
Constructs a new MainController with the specified cell manager, display, and word set.
- MainView - Class in com.slinky.hackmaster.view
-
The
MainView
class represents the main user interface of the application. - MainView(CellManager) - Constructor for class com.slinky.hackmaster.view.MainView
-
Constructs a new
MainView
with the specifiedCellManager
. - MASTER - Enum constant in enum class com.slinky.hackmaster.model.text.Difficulty
-
The most challenging difficulty level, intended for masters of the subject.
- matches(Cell) - Method in class com.slinky.hackmaster.model.cell.LetterCell
-
Compares this
Cell
with the specifiedCell
to determine if their content is identical. - matches(Cell) - Method in interface com.slinky.hackmaster.model.cell.Cell
-
Determines whether the content of this
Cell
matches the content of the specifiedCell
. - matches(Cell) - Method in class com.slinky.hackmaster.model.cell.SymbolCell
-
Determines whether the content of this
SymbolCell
matches the content of the specifiedCell
. - MIN_WORD_SIZE - Static variable in class com.slinky.hackmaster.model.cell.LetterCluster
-
The minimum acceptable size of a word.
O
- OPEN_TYPES - Static variable in class com.slinky.hackmaster.model.cell.SymbolCell
-
Characters that are considered as opening brackets.
P
- Point - Record Class in com.slinky.hackmaster.util
-
Represents a single point in 2D space.
- Point(int, int) - Constructor for record class com.slinky.hackmaster.util.Point
-
Creates an instance of a
Point
record class.
R
- removeCell(Cell) - Method in class com.slinky.hackmaster.model.cell.LetterCluster
-
Removes a
Cell
from the cluster. - removeCell(Cell) - Method in interface com.slinky.hackmaster.model.cell.CellCluster
-
Removes the
Cell
from this cluster. - removeCluster(CellCluster) - Method in interface com.slinky.hackmaster.model.cell.Cell
-
Removes this
Cell
from the specifiedCellCluster
. - removeCluster(CellCluster) - Method in class com.slinky.hackmaster.model.cell.LetterCell
-
Removes this
LetterCell
from the specifiedCellCluster
. - removeCluster(CellCluster) - Method in class com.slinky.hackmaster.model.cell.SymbolCell
-
Removes this
SymbolCell
from the specifiedCellCluster
. - removeDud(String) - Method in class com.slinky.hackmaster.model.cell.CellGrid
-
Searches through the letter clusters for a cluster containing the specified
dudText
, removes it, and returns the text of the removed cluster. - removeDud(String) - Method in interface com.slinky.hackmaster.model.cell.CellManager
-
Removes a specified dud text from the managed cells.
- removeDud(String) - Method in class com.slinky.hackmaster.model.text.StaticWordSet
-
Removes a specified dud word from the list of words.
- removeDud(String) - Method in interface com.slinky.hackmaster.model.text.WordSet
-
Removes a specified "dud" word from the word set and returns it.
- removeRandomDud() - Method in class com.slinky.hackmaster.model.text.StaticWordSet
-
Returns a word from the word set that is intentionally incorrect or invalid.
- removeRandomDud() - Method in interface com.slinky.hackmaster.model.text.WordSet
-
Returns a word from the word set that is intentionally incorrect or invalid.
- resetGuesses() - Method in class com.slinky.hackmaster.model.GameState
-
Resets the guess count to the initial starting value.
S
- setActive(boolean) - Method in class com.slinky.hackmaster.model.cell.LetterCell
-
Sets the active state of this cell.
- setActive(boolean) - Method in class com.slinky.hackmaster.model.cell.LetterCluster
-
Sets the active state of the cluster.
- setActive(boolean) - Method in interface com.slinky.hackmaster.model.cell.Cell
-
Changes the state of the cell.
- setActive(boolean) - Method in interface com.slinky.hackmaster.model.cell.CellCluster
-
Sets the active state of the cluster, activating all cells in the cluster or deactivating them
- setContent(char) - Method in interface com.slinky.hackmaster.model.cell.Cell
-
Sets the content (a character) of this
Cell
. - setContent(char) - Method in class com.slinky.hackmaster.model.cell.LetterCell
-
Sets the content of this
LetterCell
to the specified character. - setContent(char) - Method in class com.slinky.hackmaster.model.cell.SymbolCell
-
Sets the content of the cell.
- setGuessCount(int) - Method in class com.slinky.hackmaster.model.GameState
-
Sets the current number of guesses remaining for the player.
- setMessage(Label) - Method in class com.slinky.hackmaster.view.LockedOutScreen
- setStage(Stage) - Method in class com.slinky.hackmaster.controller.MainController
-
Sets the primary stage for the controller, allowing the controller to manage and change the scenes displayed on the stage.
- sharesClusterWith(Cell) - Method in interface com.slinky.hackmaster.model.cell.Cell
-
Determines whether this
Cell
shares the same cluster with another specifiedCell
. - sharesClusterWith(Cell) - Method in class com.slinky.hackmaster.model.cell.LetterCell
-
Determines whether this
LetterCell
shares the same cluster with the specifiedCell
. - sharesClusterWith(Cell) - Method in class com.slinky.hackmaster.model.cell.SymbolCell
- shuffle() - Method in class com.slinky.hackmaster.model.text.StaticWordSet
-
Shuffles the words in the word list using the Fisher-Yates algorithm.
- shuffle() - Method in interface com.slinky.hackmaster.model.text.WordSet
-
Shuffles the words in the word list.
- SimpleJumbleStrategy - Class in com.slinky.hackmaster.model.text
-
Implements the
JumbleStrategy
to generate a jumbled string by inserting random symbols between words from an input list to achieve a specified size. - SimpleJumbleStrategy() - Constructor for class com.slinky.hackmaster.model.text.SimpleJumbleStrategy
- start(Stage) - Method in class com.slinky.hackmaster.App
-
The entry point for the JavaFX application.
- startAnimation() - Method in class com.slinky.hackmaster.view.InfiniteCurveCanvas
-
Starts the animation of the Hilbert Curve.
- STARTING_GUESSES - Static variable in class com.slinky.hackmaster.model.GameConstants
-
The number of guesses the user starts with.
- StaticWordSet - Class in com.slinky.hackmaster.model.text
-
The
StaticWordSet
class is responsible for managing a set of words, providing functionality such as random selection, shuffling, and generating strings with random symbols inserted between words. - StaticWordSet(JumbleStrategy, String...) - Constructor for class com.slinky.hackmaster.model.text.StaticWordSet
-
Constructs a new
WordSet
with the specified words. - stopAnimation() - Method in class com.slinky.hackmaster.view.InfiniteCurveCanvas
-
Stops the animation of the Hilbert Curve.
- StringUtil - Class in com.slinky.hackmaster.util
-
The
StringUtil
class provides a collection of utility methods for performing common operations on strings. - StringUtil() - Constructor for class com.slinky.hackmaster.util.StringUtil
- SymbolCell - Class in com.slinky.hackmaster.model.cell
-
The
SymbolCell
class is a specialised subclass ofAbstractCell
designed to hold non-letter ASCII characters, particularly symbols. - SymbolCell(char) - Constructor for class com.slinky.hackmaster.model.cell.SymbolCell
-
Constructs a new
SymbolCell
instance containing the given content. - SymbolCluster - Class in com.slinky.hackmaster.model.cell
-
The
SymbolCluster
class extendsAbstractCluster
and is designed to manage a collection ofSymbolCell
objects. - SymbolCluster() - Constructor for class com.slinky.hackmaster.model.cell.SymbolCluster
T
- TerminalPanel - Class in com.slinky.hackmaster.view
-
The
TerminalPanel
class represents a console-like output area within the game's user interface. - TerminalPanel() - Constructor for class com.slinky.hackmaster.view.TerminalPanel
-
Constructs a new
TerminalPanel
with default settings. - toCharacterArray(String) - Static method in class com.slinky.hackmaster.util.StringUtil
-
Converts the specified
String
into an array ofCharacter
objects. - TopPanel - Class in com.slinky.hackmaster.view
-
The
TopPanel
class represents the top panel of the game UI, extending theVBox
layout. - TopPanel() - Constructor for class com.slinky.hackmaster.view.TopPanel
-
Constructs a new
TopPanel
with a specified spacing between its child elements. - toString() - Method in class com.slinky.hackmaster.model.cell.LetterCluster
-
Returns a string representation of the
CellCluster
object. - toString() - Method in class com.slinky.hackmaster.model.cell.LetterCell
-
Returns a string representation of the
LetterCell
object. - toString() - Method in class com.slinky.hackmaster.model.cell.SymbolCell
-
Returns a string representation of the
LetterCell
object. - toString() - Method in record class com.slinky.hackmaster.util.Dimension
-
Returns a string representation of this record class.
- toString() - Method in record class com.slinky.hackmaster.util.Point
-
Returns a string representation of this record class.
- turnTo2DArray(T[]) - Static method in class com.slinky.hackmaster.util.GridUtil
-
Converts a one-dimensional array into a two-dimensional array with an automatically determined number of rows and columns.
- turnTo2DArray(T[], int, int) - Static method in class com.slinky.hackmaster.util.GridUtil
-
Converts a one-dimensional array into a two-dimensional array with the specified number of rows and columns.
V
- VALID_SYMBOL - Static variable in class com.slinky.hackmaster.model.cell.LetterCell
-
The valid non-alphabetic symbol that can be added to a
LetterCell
. - validate() - Method in interface com.slinky.hackmaster.model.cell.CellCluster
-
Validates the Cluster according to the specific implementation rules.
- validate() - Method in class com.slinky.hackmaster.model.cell.LetterCluster
-
Validates that all cells in this cluster contain letter characters.
- validate() - Method in class com.slinky.hackmaster.model.cell.SymbolCluster
-
Validates the
SymbolCluster
to ensure it meets the required structure: it must start with an opening symbol and end with a corresponding closing symbol. - valueOf(String) - Static method in enum class com.slinky.hackmaster.model.text.Difficulty
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class com.slinky.hackmaster.model.text.Difficulty
-
Returns an array containing the constants of this enum class, in the order they are declared.
W
- width() - Method in record class com.slinky.hackmaster.util.Dimension
-
Returns the value of the
width
record component. - WordBank - Class in com.slinky.hackmaster.model.text
-
The
WordBank
class provides a repository of word lists categorised by difficulty levels. - WordSet - Interface in com.slinky.hackmaster.model.text
-
The
WordSet
interface defines the contract for managing a set of words with functionalities such as retrieving the total number of characters, getting a randomly selected "correct" word, shuffling the word list, and generating a jumbled string with symbols inserted between the words.
X
- x() - Method in record class com.slinky.hackmaster.util.Point
-
Returns the value of the
x
record component.
Y
- y() - Method in record class com.slinky.hackmaster.util.Point
-
Returns the value of the
y
record component.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form