Skip to content

Latest commit

 

History

History
131 lines (98 loc) · 4.31 KB

README-zh.md

File metadata and controls

131 lines (98 loc) · 4.31 KB

Mahjong Fan Calculator Python

README:English|中文

安装

pip install PyMahjongGB

使用方式

MahjongFanCalculator

from MahjongGB import MahjongFanCalculator

# 算番函数
((fanCount, fanName), ...) MahjongFanCalculator(
    pack = ((packType, tileCode, offer), ...),
    hand = (tileCode, ...),
    winTile = tileCode,
    flowerCount = int 0..8,
    isSelfDrawn = bool,
    is4thTile = bool,
    isAboutKong = bool,
    isWallLast = bool,
    seatWind = int 0..3,
    prevalentWind = int 0..3,
	[optional, default = False]verbose = bool)
  • pack（tuple套tuple）:玩家的明牌，每组packType（string）为"PENG" "GANG" "CHI" 三者之一，tileCode（string）为牌代码（吃牌表示中间牌代码），offer（int）碰、杠时123表示上家、对家、下家供牌，吃时123表示第几张是上家供牌。
  • hand（tuple）:玩家的暗牌，tileCode（string）为牌代码
  • winTile（string）:和的那张牌代码
  • flowerCount（int）:补花数
  • isSelfDrawnbool）:是否为自摸和牌
  • is4thTile（bool）:是否为和绝张
  • isAboutKong（bool）:关于杠，复合点和时为枪杠和，复合自摸则为杠上开花
  • isWallLast（bool）:是否为牌墙最后一张，复合自摸为妙手回春，否则为海底捞月
  • seatWind（int）:门风，0123表示东南西北
  • prevalentWind（int）:圈风，0123表示东南西北
  • verbose（bool，默认值为False）:用来控制返回格式，如果设置为True，返回形式为每个番型的(点数、次数、中文名、英文名)
  • 返回值（tuple套tuple）:每组int表示番数，求和为总番数，string是每个番形的描述

牌代码：

  • W1~W9：万牌
  • T1~T9：条牌
  • B1~B9：筒牌
  • F1~F4：风牌
  • J1~J3：箭牌
  • H1~H8：花牌

MahjongShanten

from MahjongGB import MahjongShanten

# 计算向听函数
shanten MahjongShanten(
    pack = ((packType, tileCode, offer), ...),
    hand = (tileCode, ...))
  • pack（tuple套tuple）:玩家的明牌，每组packType（string）为"PENG" "GANG" "CHI" 三者之一，tileCode（string）为牌代码（吃牌表示中间牌代码），offer（int）碰、杠时123表示上家、对家、下家供牌，吃时123表示第几张是上家供牌。
  • hand（tuple）:玩家的暗牌，tileCode（string）为牌代码
  • 返回值（int）:表示向听数

ThirteenOrphansShanten

from MahjongGB import ThirteenOrphansShanten

# 计算十三幺向听数，手牌必须13张
(shanten, useful) = ThirteenOrphansShanten(
    hand = (tileCode, ...))
  • hand（tuple）:玩家的暗牌，tileCode（string）为牌代码
  • 返回值（tuple）:包含一个整数表示向听数，以及一个tuple表示有效牌列表

SevenPairsShanten

from MahjongGB import SevenPairsShanten

# 计算七对向听数，手牌必须13张
(shanten, useful) = SevenPairsShanten(
    hand = (tileCode, ...))
  • hand（tuple）:玩家的暗牌，tileCode（string）为牌代码
  • 返回值（tuple）:包含一个整数表示向听数，以及一个tuple表示有效牌列表

HonorsAndKnittedTilesShanten

from MahjongGB import HonorsAndKnittedTilesShanten

# 计算全不靠向听数，手牌必须13张
(shanten, useful) = HonorsAndKnittedTilesShanten(
    hand = (tileCode, ...))
  • hand（tuple）:玩家的暗牌，tileCode（string）为牌代码
  • 返回值（tuple）:包含一个整数表示向听数，以及一个tuple表示有效牌列表

KnittedStraightShanten

from MahjongGB import KnittedStraightShanten

# 计算组合龙向听数，手牌必须10张或者13张
(shanten, useful) = KnittedStraightShanten(
    hand = (tileCode, ...))
  • hand（tuple）:玩家的暗牌，tileCode（string）为牌代码
  • 返回值（tuple）:包含一个整数表示向听数，以及一个tuple表示有效牌列表

RegularShanten

from MahjongGB import RegularShanten

# 计算基本胡型的向听数，手牌可以是1, 4, 7, 10, 13张
(shanten, useful) = RegularShanten(
    hand = (tileCode, ...))
  • hand（tuple）:玩家的暗牌，tileCode（string）为牌代码
  • 返回值（tuple）:包含一个整数表示向听数，以及一个tuple表示有效牌列表