Reference · Tiles, layouts and deals
findFacefunction
The tile a text names, or null. It takes a face's code (F, case matters: one letter is a code); its English
name in any usual spelling ("3 of circles", "circles 3", "three circles", "east wind", "plum", "red dragon"); its
Japanese name (三筒, 東, 中) or the readings players use (ton, haku); and the notation hands are written in,
a number and a suit letter: 3m characters, 3p circles, 3s bamboo, 1z–4z the winds and 5z–7z white,
green and red (the riichi order), plus 1f and 1t for the flowers and seasons, which are Jarajara's own.
0m, 0p and 0s are the red fives, which are fives here.
Import it
import { findFace } from "@johnmorrisdotca/jarajara";
Definition
function findFace(text: string): MahjongFace | null
Parameters
| Name | Type | Description |
|---|---|---|
text | string | The unknown text or encoded record to interpret. |
Returns
MahjongFace | null
The tile a text names, or null. It takes a face's code (F, case matters: one letter is a code); its English name in any usual spelling ("3 of circles", "circles 3", "three circles", "east wind", "plum", "red dragon"); its Japanese name (三筒, 東, 中) or the readings players use (ton, haku); and the notation hands are written in, a number and a suit letter: 3m characters, 3p circles, 3s bamboo, 1z–4z the winds and 5z–7z white, green and red (the riichi order), plus 1f and 1t for the flowers and seasons, which are Jarajara's own. 0m, 0p and 0s are the red fives, which are fives here.
Examples
import { findFace } from "@johnmorrisdotca/jarajara";
console.log(findFace("red dragon"));{ code: 'F', suit: 'dragons', rank: 1 }What it prints (run when this page was built)