ddz

ddz

斗地主工具包，正在开发中

安装

• 本地

npm i ddz -S

import ddz from 'ddz'

• CDN

<script src="//unpkg.com/ddz"></script>

文档

• card(point[, suit])
• cards()
• length(type)
• point(card)
• shuffle(cards[, mode])
• sort(cards[, desc])
• suit(card)
• surface(point)
• version()

card(point[, suit])

• point <number|string> 点数 | 牌面
• suit <number> 花色。留空默认为 0
• returns: <number> 牌值

创建一张牌

cards()

• returns: <Array<number>> 牌值数组

创建一副新牌，从小到大，黑红梅方，一共 54 张

length(type)

• type <string> 牌型
• returns: <number> 长度

获取指定牌型的长度

point(card)

• card <number|string> 牌值 | 牌面
• returns: <number> 点数

获取指定牌的点数

shuffle(cards[, mode])

• cards <Array<number>> 牌值数组
• mode <string> 模式。默认 standard 使用 lodash/shuffle
• returns: <Array<number>> 打乱过的牌值数组

洗牌，目前暂时只有标准模式，后期增加炸弹模式等

sort(cards[, desc])

• cards <Array<number>> 牌值数组
• desc <boolean> 是否降序。默认 false 升序
• returns: <Array<number>> 排序过的牌值数组

排序，支持升序和降序

suit(card)

• card <number> 牌值
• returns: <number> 花色

获取指定牌的花色

surface(point)

• point <number> 点数
• returns: <string> 牌面

获取指定点数的牌面

version()

• returns: <string> 版本号

获取当前库版本号

ddz.version() // 'x.y.z'

说明

名词	范围	解释
点数	1 ~ 15	用于判断牌的大小
牌值	0x11 ~ 0xF0	牌的数值形式，用于排序
牌面	34567890JQKA2XD	牌的文字表示，用于展示
花色	0 ~ 5	王牌和黑红梅方花色，用于展示或排序