Struct rusty_freecell::game::Game

pub struct Game {
    field: [Vec<Card>; 16],
    highlighted_card: usize,
    selected_card_opt: Option<usize>,
    undo_history: CircularBuffer<UNDO_LEVELS, Move>,
    move_count: u32,
    high_contrast: bool,
}

Represents the state of a FreeCell game.

Fields

field: [Vec<Card>; 16]

The playing field, consisting of stacks of cards.

highlighted_card: usize

The index of the card the player currently has highlighted

selected_card_opt: Option<usize>

The index of the card the player has marked to be moved, if any.

undo_history: CircularBuffer<UNDO_LEVELS, Move>

The circular buffer storing the game’s undo history.

move_count: u32

The number of moves made so far in the game.

high_contrast: bool

Indicates whether the game is in high contrast mode, where each suit is printed in a different color.

Implementations

impl Game

pub fn print(&self, out: &mut Stdout) -> Result<(), Error>

Prints the game state to the terminal.

Arguments

• out - A mutable reference to the standard output stream.

Returns

A Result indicating success or an error if writing to the output stream fails.

fn print_board(&self, out: &mut Stdout) -> Result<(), Error>

Prints the game board layout to the terminal.

fn print_chrome(out: &mut Stdout, move_count: u32) -> Result<(), Error>

Prints the game chrome (title, side bars, etc.) to the terminal.

fn print_card_at_coord( out: &mut Stdout, x: u16, y: u16, card: Card, highlighted: bool, selected: bool, high_contrast: bool ) -> Result<(), Error>

Prints a card at the specified coordinates on the terminal.

fn print_win(out: &mut Stdout) -> Result<(), Error>

Prints the win message to the terminal.

fn print_string_at_coord( out: &mut Stdout, string: &str, x: u16, y: u16 ) -> Result<(), Error>

Prints a string at the specified coordinates on the terminal.

impl Game

pub fn new(rng: &mut ThreadRng) -> Game

Creates a new instance of the FreeCell game.

Arguments

• rng - A mutable reference to a random number generator.

Returns

A new Game instance.

pub fn is_won(&self) -> bool

Checks if the game has been won.

Returns

true if the game has been won, otherwise false.

pub fn toggle_high_contrast(&mut self)

Toggles high contrast mode, making diamonds magenta and spades yellow.

pub fn move_cursor_left(&mut self)

Moves the cursor to the left on the game field, skipping invalid spots.

pub fn move_cursor_right(&mut self)

Moves the cursor to the right on the game field, skipping invalid spots.

pub fn quick_stack_to_foundations(&mut self)

Quick stacks all visible cards to the foundation piles, recursively.

pub fn handle_card_press(&mut self)

Handles the event where a player clicks space/enter on a card.

pub fn player_try_execute_move(&mut self, from: usize, to: usize)

Executes a player move if it is valid.

pub fn perform_undo(&mut self)

Undoes the last move made by the player. Can be used multiple times to travel back in the game’s history.

fn are_opposite_colors(card1: Card, card2: Card) -> bool

Checks if two cards are of opposite colors.

fn move_is_valid(&self, from: usize, to: usize) -> bool

Checks if a move from one position to another is valid.

fn execute_move(&mut self, from: usize, to: usize)

Executes a move from one position to another, not checking if it follows the rules. To try executing a move in a way that fails if the move does not follow the rules, use player_try_execute_move.