extended README with new features and added new swap modes to the board

README.md

@@ -20,12 +20,29 @@
 - [Getting started 🚀](#getting-started-)
 - [Editor preview 🪲](#editor-preview-)
   - [Parameters](#parameters)
-- [Board size](#board-size)
-  - [Parameters](#parameters-1)
-- [Match configuration](#match-configuration)
+- [Board Parameters](#board-parameters)
+  - [Size](#size)
+  - [Match configuration](#match-configuration)
+    - [Pieces collision layer](#pieces-collision-layer)
+    - [Swap mode](#swap-mode)
+      - [Adjacent](#adjacent)
+      - [Adjacent with diagonals](#adjacent-with-diagonals)
+      - [Adjacent only diagonals](#adjacent-only-diagonals)
+      - [Free](#free)
+      - [Row](#row)
+      - [Column](#column)
+      - [Cross](#cross)
+      - [Cross Diagonals](#cross-diagonals)
+      - [Connect Line](#connect-line)
+- [Add spawn pieces to the board](#add-spawn-pieces-to-the-board)
 - [GridCellUI](#gridcellui)
   - [Position](#position)
   - [Empty cell](#empty-cell)
+  - [Get neighbour cells](#get-neighbour-cells)
+  - [Piece](#piece)
+    - [Information](#information)
+    - [Add or remove](#add-or-remove)
+    - [Swap (internal use, not recommended for manual use )](#swap-internal-use-not-recommended-for-manual-use-)
 
 # 📦 Installation
 
@@ -73,26 +90,94 @@ You have available default textures on this plugin to visualize a preview in the
 - **Even cell texture:** The texture to place in even cell positions in the board
 - **Empty cells:** Set empty cells where a piece shall not be drawn in the shape of Vector2i(row, column)
 
-# Board size
+# Board Parameters
 
 ---
 
 ![editor_preview_match_3](images/match3_size_parameters.png)
 
 ---
 
-## Parameters
+## Size
 
 - **Grid width:** The row width of the grid, a width of 7 means that 7 pieces will be drawed by row
 - **Grid height:** The column height of the grid, a height o 8 means that 8 pieces will be drawed by column
 - **Cell size:** The size of the cell in the world in the shape of Vector2(x, y). It's recommended to keep this values equals for better display
 - **Cell offset:** The offset from the corner if you want to create more space.
 
-ℹ️ _\_With the `preview enabled`, any changes you make to the board's parameters _(like grid size or piece definitions)\_ will be instantly reflected in the preview window. This allows you to quickly iterate and experiment with different configurations\_\_ ℹ️
+ℹ️ **_With the `preview enabled`, any changes you make to the board's parameters \_(like grid size or piece definitions)\_ will be instantly reflected in the preview window. This allows you to quickly iterate and experiment with different configurations_** ℹ️
+
+## Match configuration
+
+---
+
+![board_match_parameters](images/board_match_parameters.png)
+
+---
+
+### Pieces collision layer
+
+The collision layer where the pieces are set. Its values are from `1 to 32` and this allows you to not override existing layers in your Godot project
+
+### Swap mode
+
+This is the `swap_mode` to find matches on the pieces. **They can be changed at runtime** and you have the next ones availables:
+
+#### Adjacent
+
+An individual piece can swap with adjacent pieces but diagonal neighbours are not included.
+
+![swap_adjacent](images/swap_adjacent.png)
+
+#### Adjacent with diagonals
+
+Same as adjacent mode but this time diagonal neighbours are included
+
+![swap_adjacent](images/swap_diagonal_diagonal.png)
+
+#### Adjacent only diagonals
+
+Same as adjacent mode but this time only diagonal neighbours are included
+
+![swap_adjacent](images/swap_diagonal.png)
 
-# Match configuration
+#### Free
 
-WIP
+The piece can be swapped with any other
+
+![swap_free](images/swap_free.png)
+
+#### Row
+
+The piece can be swapped in the entire row it belongs
+
+![swap_adjacent](images/swap_row.png)
+
+#### Column
+
+The piece can be swapped in the entire column it belongs
+
+![swap_adjacent](images/swap_column.png)
+
+#### Cross
+
+The piece can be swapped on a cross that is a mix of `Row & Column`
+
+![swap_adjacent](images/swap_cross.png)
+
+#### Cross Diagonals
+
+The piece can be swapped on cross but using diagonals instead
+
+![swap_adjacent](images/swap_cross_diagonal.png)
+
+#### Connect Line
+
+Connect the adjacent pieces from a line that originates from the selected cell until the maximum match of pieces or triggered manually.
+
+![swap_adjacent](images/swap_connect_line.png)
+
+# Add spawn pieces to the board
 
 # GridCellUI
 
@@ -102,8 +187,114 @@ The Swaps between pieces are done via this `GridCellUI` node so **_the pieces ar
 
 ## Position
 
-To obtain the position of a cell you have access to variables `row`, `column` and method `board_position()`. This method returns a `Vector2i(row, column)`
+To obtain the position of a cell you have access to variables `row`, `column` and method `board_position()`. This method returns a `Vector2i(row, column)`.
+
+In addition, there are methods to check for more advanced cases with other cells to know the relative position in the board
+
+```swift
+func in_same_row_as(other_cell: GridCellUI) -> bool
+
+func in_same_column_as(other_cell: GridCellUI) -> bool
+
+func in_same_position_as(other_cell: GridCellUI) -> bool
+
+func in_same_grid_position_as(grid_position: Vector2) -> bool
+
+func is_row_neighbour_of(other_cell: GridCellUI) -> bool
+
+func is_column_neighbour_of(other_cell: GridCellUI) -> bool
+
+func is_adjacent_to(other_cell: GridCellUI) -> bool
+
+func in_diagonal_with(other_cell: GridCellUI) -> bool:
+```
+
+---
+
+There are more methods available to determine if it is a corner or a border
+
+```swift
+
+func is_top_left_corner() -> bool:
+
+func is_top_right_corner() -> bool
+
+func is_bottom_left_corner() -> bool
+
+func is_bottom_right_corner() -> bool
+
+func is_top_border() -> bool
+
+func is_bottom_border() -> bool
+
+func is_right_border() -> bool
+
+func is_left_border() -> bool:
+```
 
 ## Empty cell
 
 If the position of this cell match with any of the `empty_cells` vectors from the `Match3Board`, this cell will change the variable `can_contain_piece` to false and you can choose if draw the background texture or not with the variable `draw_background_texture`.
+
+## Get neighbour cells
+
+When the board is drawed and cells initialized, each one has access to the adjacent neighbours, you can access them with the variables:
+
+```swift
+neighbour_up,
+neighbour_bottom,
+neighbour_right,
+neighbour_left,
+diagonal_neighbour_top_right,
+diagonal_neighbour_top_left,
+diagonal_neighbour_bottom_right,
+diagonal_neighbour_bottom_left
+```
+
+In addition you can access the neighbour cells that are available through the methods:
+
+```swift
+func available_neighbours(include_diagonals: bool = false) -> Array[GridCellUI]
+
+func diagonal_neighbours() -> Array[GridCellUI]:
+```
+
+## Piece
+
+The cell has direct access to the related piece on variable `current_piece`, this `GridCellUI` class provides useful methods to manipulate them:
+
+### Information
+
+Available methods to know if the cell has a piece or not
+
+```swift
+func is_empty() -> bool
+
+func has_piece() -> bool
+```
+
+### Add or remove
+
+Methods to assign or remove a piece. This methods does not remove the piece from the board UI, only from the cell.
+
+```swift
+// Assign a piece only if the cell is empty unless "overwrite" is true
+func assign_piece(new_piece: PieceUI, overwrite: bool = false) -> void
+
+// Replace the current piece to the new one even if the cell is empty
+func replace_piece(new_piece: PieceUI) -> PieceUI
+
+// Remove the current piece and return it if the cell was not empty.
+func remove_piece() -> PieceUI?
+```
+
+### Swap (internal use, not recommended for manual use )
+
+All the swap are dones through the cells, although **it is not recommended to use these methods directly.** Rather, set up the pieces and their rules individually and consume them with a `SequenceConsumer`.
+
+```swift
+func swap_piece_with(other_cell: GridCellUI) -> bool
+
+func can_swap_piece_with(other_cell: GridCellUI) -> bool
+
+```

addons/ninetailsrabbit.match3_board/src/components/grid_cell_ui.gd

@@ -4,7 +4,7 @@ signal swapped_piece(from: GridCellUI, to: GridCellUI)
 signal swap_rejected(from: GridCellUI, to: GridCellUI)
 signal removed_piece(piece: PieceUI)
 
-const group_name: String = "grid_cell"
+const GroupName: String = "grid_cells"
 
 @export var column: int
 @export var row: int
@@ -47,7 +47,7 @@ func _init(_row: int, _column: int, piece: PieceUI = null, _can_contain_piece: b
 
 
 func _enter_tree() -> void:
-	add_to_group(group_name)
+	add_to_group(GroupName)
 
 	name = "Cell_Column%d_Row%d" % [column, row]
 	z_index = 20
@@ -115,8 +115,10 @@ func is_column_neighbour_of(other_cell: GridCellUI) -> bool:
 		and [upper_row, bottom_row].any(func(near_row: int): return other_cell.row == near_row)
 
 
-func is_adjacent_to(other_cell: GridCellUI) -> bool:
-	return is_row_neighbour_of(other_cell) or is_column_neighbour_of(other_cell)
+func is_adjacent_to(other_cell: GridCellUI, check_diagonal: bool = false) -> bool:
+	return is_row_neighbour_of(other_cell) \
+		or is_column_neighbour_of(other_cell) \
+		or (check_diagonal and in_diagonal_with(other_cell))
 
 
 func in_diagonal_with(other_cell: GridCellUI) -> bool:
@@ -242,7 +244,6 @@ func available_neighbours(include_diagonals: bool = false) -> Array[GridCellUI]:
 			diagonal_neighbour_bottom_left
 		]))
 	else:
-
 		neighbours.assign(Match3BoardPluginUtilities.remove_falsy_values([
 			neighbour_up,
 			neighbour_bottom,
@@ -253,6 +254,19 @@ func available_neighbours(include_diagonals: bool = false) -> Array[GridCellUI]:
 	return neighbours
 
 
+func diagonal_neighbours() -> Array[GridCellUI]:
+	var neighbours: Array[GridCellUI] = []
+
+	neighbours.assign(Match3BoardPluginUtilities.remove_falsy_values([
+			diagonal_neighbour_top_right,
+			diagonal_neighbour_top_left,
+			diagonal_neighbour_bottom_right,
+			diagonal_neighbour_bottom_left
+		]))
+
+	return neighbours
+
+
 func can_swap_piece_with(other_cell: GridCellUI) -> bool:
 	return other_cell != self \
 		and other_cell.has_piece() \

addons/ninetailsrabbit.match3_board/src/components/highlighters/cell_highlighter.gd

@@ -1,11 +1,13 @@
 class_name CellHighlighter extends Node
 
+const GroupName: String = "cell-highlighter"
+
 @export var highlight_texture: Texture2D = Match3Preloader.HighlightedTexture
 
-@onready var board = get_tree().get_first_node_in_group(Match3Preloader.BoardGroupName)
+@onready var board: Match3Board = get_tree().get_first_node_in_group(Match3Preloader.BoardGroupName)
 
 func _enter_tree() -> void:
-	name = "CellHighlighter"
+	name = GroupName
 
 
 func highlight_cell(grid_cell: GridCellUI) -> void:
@@ -25,14 +27,22 @@ func highlight_cells_from_origin_cell(origin_cell: GridCellUI, swap_mode: Match3
 	match swap_mode:
 		Match3Preloader.BoardMovements.Adjacent:
 			highlight_cells(origin_cell.available_neighbours(false))
-		Match3Preloader.BoardMovements.Cross:
-			highlight_cells(board.cross_cells_from(origin_cell))
+		Match3Preloader.BoardMovements.AdjacentWithDiagonals:
+			highlight_cells(origin_cell.available_neighbours(true))
+		Match3Preloader.BoardMovements.AdjacentOnlyDiagonals:
+			highlight_cells(origin_cell.diagonal_neighbours())
 		Match3Preloader.BoardMovements.Free:
 			highlight_cell(origin_cell)
+		Match3Preloader.BoardMovements.Row:
+			highlight_cells(board.grid_cells_from_row(origin_cell.row))
+		Match3Preloader.BoardMovements.Column:
+			highlight_cells(board.grid_cells_from_column(origin_cell.column))
+		Match3Preloader.BoardMovements.Cross:
+			highlight_cells(board.cross_cells_from(origin_cell))
 		Match3Preloader.BoardMovements.CrossDiagonal:
 			highlight_cells(board.cross_diagonal_cells_from(origin_cell))
-
-	
+				
+
 func remove_current_highlighters() -> void:
 	for grid_cell: GridCellUI in board.grid_cells_flattened:
 		remove_highlight(grid_cell)

addons/ninetailsrabbit.match3_board/src/components/pieces/piece_weight.gd

@@ -3,8 +3,18 @@ class_name PieceWeight extends Resource
 @export var weight: float = 1.0
 @export var piece_scene: PackedScene
 
+
+var current_weight: float = weight
 var total_accum_weight: float = 0.0
 
 
 func reset_accum_weight() -> void:
 	total_accum_weight = 0.0
+
+
+func change_weight(new_value: float) -> void:
+	current_weight = new_value
+
+
+func change_to_original_weight() -> void:
+	current_weight = weight

addons/ninetailsrabbit.match3_board/src/components/pieces/swap_mode/line_connector.gd

@@ -134,7 +134,8 @@ func on_added_piece(piece: PieceUI) -> void:
 		remove_point(points.size() - 1)
 		detection_area.process_mode = Node.PROCESS_MODE_DISABLED
 		queue_free()
-
+
+
 func on_line_match_selected(selected_pieces: Array[PieceUI]) -> void:
 	var cells: Array[GridCellUI] = []
 	cells.assign(selected_pieces.map(func(piece: PieceUI): return piece.board.grid_cell_from_piece(piece)))

addons/ninetailsrabbit.match3_board/src/debug_ui/match3_preloader.gd

@@ -22,7 +22,11 @@ enum BoardState {
 
 enum BoardMovements {
 	Adjacent,
+	AdjacentWithDiagonals,
+	AdjacentOnlyDiagonals,
 	Free,
+	Row,
+	Column,
 	Cross,
 	CrossDiagonal,
 	ConnectLine