Struct riichi_tools_rs::riichi::hand::Hand

pub struct Hand { /* fields omitted */ }

Implementations

impl Hand

pub fn new(tiles: Vec<Option<Tile>>) -> Hand

pub fn validate(&self) -> bool

Checks the hand for invalid things (wrong number of tiles, > 4 same tiles…)

pub fn get_tiles(&self) -> &Vec<Option<Tile>>

pub fn get_shapes(&self) -> &Vec<CompleteShape>

pub fn get_open_shapes(&self) -> Vec<OpenShape>

Returns a vector of OpenShape from shapes that we have identified in the hand.

pub fn get_34_array(&self, remove_open_tiles: bool) -> [u8; 34]

Converts our tiles vector to an array of 34 counts, since riichi has 34 different tiles. remove_open_tiles: ignores chi, pon and kanned tiles (also closed kans)

pub fn random_complete_hand(closed: bool, kans: bool) -> Hand

Generate a 14 tile hand that is complete TODO fix kan generation TODO add open hand generation

pub fn random_hand(rules: Option<&Rules>) -> Hand

Generate a random closed hand

pub fn from_text(
    representation: &str,
    force_return: bool
) -> Result<Hand, RiichiError>

Parses a hand from its text representation. force_return: will return even a partial/invalid hand TODO: red 5

pub fn add_tile(&mut self, tile: Tile)

Adds a tile to this hand

pub fn remove_tile(&mut self, tile: &Tile)

Removes a tile from this hand

pub fn remove_tile_by_id(&mut self, tile_id: u8)

Removes a tile by ID

pub fn add_open_shape(&mut self, shape: &OpenShape)

Goes through the tiles and dedicates them to an open shape

pub fn add_closed_kan(&mut self, kan: ClosedShape)

pub fn count_tiles(&self) -> usize

Returns the size of a hand - usually 13 or 14 tiles, depending on the situation.

pub fn get_closed_kans(&self) -> u8

pub fn is_closed(&self) -> bool

pub fn convert_to_string(&self) -> String

Renders the hand as a string representation. The notation looks like this: Tiles are written as NC (number + color) More tiles of the same color can be written consecutively (1234p) z = honors - 1-4 = winds, 5-7 = dragons 0mps = red 5 (TODO) Open shapes are in brackets, (123s2) (p1s1) (k2p3) etc. See parse_* functions for more info

pub fn to_vec_of_strings(&self, no_shapes: bool) -> Vec<String>

Returns the tiles of the hand as a vec of their string representations. Can be returned without open/closed shapes.

pub fn shanten(&mut self) -> i8

Get shanten of this hand (and also set it if it’s not calculated yet)

pub fn get_shanten(&self) -> i8

Get shanten of this hand

pub fn reset_shanten(&mut self)

Reset shanten to 99 when we change the hand somehow

pub fn find_shanten_improving_tiles(
    &mut self,
    visible_tiles: Option<&[u8; 34]>
) -> Vec<(Option<Tile>, Vec<(Tile, u8)>, u8)>

Returns tiles that can be used to improve this hand. For 13 tile hands, there is only one option. For 14 tile hands, we list options for all discards that don’t lower our shanten. You can set visible_tiles that you can see on the table and it will remove them from the final list / ukeire count

pub fn reset_drawn_tiles(&mut self)

pub fn get_drawn_tile(&self) -> Option<&Tile>

Trait Implementations

impl Clone for Hand

fn clone(&self) -> Hand

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for Hand

fn default() -> Hand

Returns the “default value” for a type.

impl Display for Hand

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.